The GetNumPhoneLines API is used to determine the number of phone lines the telephony engine is currently managing. This is the same number of phone lines that was specified by the user when the telephony engine was created. The number of phone lines returned by this API procedure will be less than or equal to the total number of lines you are licensed to use.

Namespace:  LanScape
Assembly:  LMEVoipManaged (in LMEVoipManaged.dll) Version: 6.0.5226.26700

Syntax

C#
public VoipMediaEngine..::.TELEPHONY_RETURN_VALUE GetNumPhoneLines(
	ref int NumPhoneLines
)
Visual Basic (Declaration)
Public Function GetNumPhoneLines ( _
	ByRef NumPhoneLines As Integer _
) As VoipMediaEngine..::.TELEPHONY_RETURN_VALUE
Visual C++
public:
VoipMediaEngine..::.TELEPHONY_RETURN_VALUE GetNumPhoneLines(
	int% NumPhoneLines
)
J#
public VoipMediaEngine..::.TELEPHONY_RETURN_VALUE GetNumPhoneLines(
	/** @ref */int NumPhoneLines
)

Parameters

NumPhoneLines
Type: System..::.Int32 %
A reference to an integer variable that will receive the number of phone lines being managed.

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 ValueDescription
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)

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)

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)

Remarks

None.

See Also