The GetNumRecordedCallStates procedure is called by application software to obtain the number of
call states that have been recorded for the specified phone line.
In order for this API procedure to be of any use, applications software should enable phone line call
state recording using the SetCallStateRecording API procedure.
Namespace:
LanScapeAssembly: LMEVoipManaged (in LMEVoipManaged.dll) Version: 6.0.5226.26700
Syntax
C# |
---|
public VoipMediaEngine..::.TELEPHONY_RETURN_VALUE GetNumRecordedCallStates( int PhoneLine, ref int NumRecordedCallStates ) |
Visual Basic (Declaration) |
---|
Public Function GetNumRecordedCallStates ( _ PhoneLine As Integer, _ ByRef NumRecordedCallStates As Integer _ ) As VoipMediaEngine..::.TELEPHONY_RETURN_VALUE |
Visual C++ |
---|
public: VoipMediaEngine..::.TELEPHONY_RETURN_VALUE GetNumRecordedCallStates( int PhoneLine, int% NumRecordedCallStates ) |
J# |
---|
public VoipMediaEngine..::.TELEPHONY_RETURN_VALUE GetNumRecordedCallStates( int PhoneLine, /** @ref */int NumRecordedCallStates ) |
Parameters
- PhoneLine
- Type: System..::.Int32
The zero based phone line to access.
- NumRecordedCallStates
- Type:
System..::.Int32
%
This parameter specifies the reference to a variable that will contain the number of call states that have been recorded.
Return Value
If the function succeeds, the return value will be SipSuccess.
If the function fails, the return value will be one of the following values as specified by the VoipMediaEngine..::.TELEPHONY_RETURN_VALUE data type.
Return Value | Description |
---|---|
SipCallFailure |
This value is returned by telephony API procedures to indicate general API failure. This error value is used as a "catch all error". If you receive this error, check to make sure that all parameters specified in the API procedure call are correct. Particularly, verify that pointers to memory regions are valid. This error return value is only used if a mapping to another specific error value does not exist.
(API return value) |
SipInvalidHandle |
Application software specified an invalid telephony handle in one of the API procedures.
This usually indicates memory corruption on the part of application software.
(API return value) |
SipBadPhoneLine |
Application software called a telephony API procedure and specified an invalid phone line. Phone lines are numbered starting from zero. This error is most commonly returned when attempting to access phone lines in excess of the max number of lines supported by the telephony engine.
(API return value) |
SipBadParameter |
One of the telephony API procedures was called by application software and was passed a pointer to an invalid
memory address. Normally this error will occur when application software passes NULL pointer values to the telephony API.
For managed code applications, you should never see this error unless your process space has exhausted memory.
(API return value) |
Remarks
None.