The GetActiveCallInfo can be called by a user application when the telephony engine indicates that call information for a specific phone line has been established or some line characteristic has changed.

Generally you would call this procedure when the event callback sends you one of the following events: SipIncomingCallConnected, SipOutgoingCallConnected, SipCallHoldOn, SipCallHoldOff, SipFarEndHoldOn, SipFarEndHoldOff, SipInConferenceOn or SipInConferenceOff. For further information see VoipMediaEngine..::.TELEPHONY_RETURN_VALUE.

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


public VoipMediaEngine..::.TELEPHONY_RETURN_VALUE GetActiveCallInfo(
	int PhoneLine,
	VoipMediaEngine..::.SIP_ACTIVE_CALL_INFO ActiveCallInfo
Visual Basic (Declaration)
Public Function GetActiveCallInfo ( _
	PhoneLine As Integer, _
	ActiveCallInfo As VoipMediaEngine..::.SIP_ACTIVE_CALL_INFO _
Visual C++
VoipMediaEngine..::.TELEPHONY_RETURN_VALUE GetActiveCallInfo(
	int PhoneLine, 
	VoipMediaEngine..::.SIP_ACTIVE_CALL_INFO^ ActiveCallInfo
public VoipMediaEngine..::.TELEPHONY_RETURN_VALUE GetActiveCallInfo(
	int PhoneLine,
	VoipMediaEngine..::.SIP_ACTIVE_CALL_INFO ActiveCallInfo


Type: System..::.Int32
The zero based phone line to access.
Type: LanScape..::.VoipMediaEngine..::.SIP_ACTIVE_CALL_INFO
A reference to a class object of type VoipMediaEngine..::.SIP_ACTIVE_CALL_INFO. Upon successful completion, the object referenced by this parameter will be filled with the currently available active call 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 ValueDescription
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)

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)

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)

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)



See Also