GetActiveCallInfo

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 TELEPHONY_RETURN_VALUE.

TELEPHONY_RETURN_VALUE GetActiveCallInfo(

SIPHANDLE hStateMachine,

int PhoneLine,

SIP_ACTIVE_CALL_INFO *pActiveCallInfo

);

Parameters:

hStateMachine

[in] The handle to the telephony engine. This is the handle that was returned by a previous call to the StartSipTelephony procedure.

PhoneLine

[in] The zero based phone line to access.

pActiveCallInfo

[out] A pointer to a structure variable of type SIP_ACTIVE_CALL_INFO. Upon successful completion, the address pointed to 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 TELEPHONY_RETURN_VALUE data type.

Value	Description
SipCallFailure	This is a generic "catch all" API error. If an error condition is not specified by any other API error value, this error will be returned.
SipBadParameter	For API procedures that receive pointers from user software, this error indicates that a NULL pointer condition was detected. Make sure all pointers your software passes to the telephony API are valid.
SipInvalidHandle	An API procedure was passed an invalid handle. The telephony engine attempts to verify user specified telephony handles and returns this error when an invalid handle is detected.
SipBadPhoneLine	A telephony operation was specified using an invalid phone line. Phone lines are numbered starting from zero.