The GetLineStatus API procedure can be called asynchronously by application software to determine
the current state of any phone line.
Namespace:
LanScapeAssembly: LMEVoipManaged (in LMEVoipManaged.dll) Version: 6.0.5226.26700
Syntax
| C# |
|---|
public VoipMediaEngine..::.TELEPHONY_RETURN_VALUE GetLineStatus( int PhoneLine, VoipMediaEngine..::.LINE_STATE LineState ) |
| Visual Basic (Declaration) |
|---|
Public Function GetLineStatus ( _ PhoneLine As Integer, _ LineState As VoipMediaEngine..::.LINE_STATE _ ) As VoipMediaEngine..::.TELEPHONY_RETURN_VALUE |
| Visual C++ |
|---|
public: VoipMediaEngine..::.TELEPHONY_RETURN_VALUE GetLineStatus( int PhoneLine, VoipMediaEngine..::.LINE_STATE^ LineState ) |
| J# |
|---|
public VoipMediaEngine..::.TELEPHONY_RETURN_VALUE GetLineStatus( int PhoneLine, VoipMediaEngine..::.LINE_STATE LineState ) |
Parameters
- PhoneLine
- Type: System..::.Int32
The zero based phone line to access.
- LineState
- Type: LanScape..::.VoipMediaEngine..::.LINE_STATE
A reference to a variable of type VoipMediaEngine..::.LINE_STATE. Upon successful completion, this parameter will contain the current line state information.
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
IMPORTANT:
If your VOIP application software calls the GetLineStatus API procedure using a polling method to obtain phone line state information, make sure your polling thread logic calls the GetLineStatus API procedure at an acceptable rate. The GetLineStatus API procedure introduces minimal thread execution delay and your polling thread will consume 100% of your CPU if the procedure is called too often.
See Also
