The GetOutgoingCallErrorInfo API procedure can be called by a user application to retrieve additional error information associated with an outgoing call. Under normal operating conditions, a far end SIP device or gateway may respond to a call initiation (INVITE request) by sending back an error response indication.

Application software can call this API procedure any time after it receives the SipFarEndIsBusy or SipFarEndError events from the media engine to retrieve the error information. Note that your application software should also call this API procedure before terminating the phone call using the TerminateCall(Int32, Boolean, UInt32) API procedure.

The out going call information that will be made available to you is contained in a structure variable of type VoipMediaEngine..::.SIP_OUTGOING_CALL_ERROR_INFO.

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

Syntax

C#
public VoipMediaEngine..::.TELEPHONY_RETURN_VALUE GetOutgoingCallErrorInfo(
	int PhoneLine,
	VoipMediaEngine..::.SIP_OUTGOING_CALL_ERROR_INFO OutgoingCallErrorInfo
)
Visual Basic (Declaration)
Public Function GetOutgoingCallErrorInfo ( _
	PhoneLine As Integer, _
	OutgoingCallErrorInfo As VoipMediaEngine..::.SIP_OUTGOING_CALL_ERROR_INFO _
) As VoipMediaEngine..::.TELEPHONY_RETURN_VALUE
Visual C++
public:
VoipMediaEngine..::.TELEPHONY_RETURN_VALUE GetOutgoingCallErrorInfo(
	int PhoneLine, 
	VoipMediaEngine..::.SIP_OUTGOING_CALL_ERROR_INFO^ OutgoingCallErrorInfo
)
J#
public VoipMediaEngine..::.TELEPHONY_RETURN_VALUE GetOutgoingCallErrorInfo(
	int PhoneLine,
	VoipMediaEngine..::.SIP_OUTGOING_CALL_ERROR_INFO OutgoingCallErrorInfo
)

Parameters

PhoneLine
Type: System..::.Int32
The zero based phone line to access.
OutgoingCallErrorInfo
Type: LanScape..::.VoipMediaEngine..::.SIP_OUTGOING_CALL_ERROR_INFO
A pointer to a structure variable of type VoipMediaEngine..::.SIP_OUTGOING_CALL_ERROR_INFO. Upon successful completion, the address pointed to by this parameter will be filled with out going call error 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
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)

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)

Remarks

None.

See Also