When incoming request authentication is enabled, the media engine will send the SipIncomingAuthentication event to your application whenever a far end application or device responds to our challenge with authentication response data.

Along with the event, your application can access a VoipMediaEngine..::.CHALLENGE_AUTHENTICATION class instance which contains data specific to the challenge response the far end sent. If the Operation member of the VoipMediaEngine..::.CHALLENGE_AUTHENTICATION class is set to the value AUTHENTICATE_VERIFY_CREDENTIALS, then the challenge handle member of the VoipMediaEngine..::.CHALLENGE_AUTHENTICATION class is available to your application. Your application can use this handle to verify the challenge response by calling this API procedure.

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

Syntax

C#
public VoipMediaEngine..::.TELEPHONY_RETURN_VALUE VerifyChallengeResponse(
	uint hChallenge,
	string Password,
	string Realm
)
Visual Basic (Declaration)
Public Function VerifyChallengeResponse ( _
	hChallenge As UInteger, _
	Password As String, _
	Realm As String _
) As VoipMediaEngine..::.TELEPHONY_RETURN_VALUE
Visual C++
public:
VoipMediaEngine..::.TELEPHONY_RETURN_VALUE VerifyChallengeResponse(
	unsigned int hChallenge, 
	String^ Password, 
	String^ Realm
)
J#
public VoipMediaEngine..::.TELEPHONY_RETURN_VALUE VerifyChallengeResponse(
	UInt32 hChallenge,
	String Password,
	String Realm
)

Parameters

hChallenge
Type: System..::.UInt32
A "handle" to internal authentication challenge information. This handle represents authentication information received from the far end.
Password
Type: System..::.String
A string that contains the password for your authentication realm.
Realm
Type: System..::.String
A string that contains the name of your authentication realm.

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