If your application is required to challenged requests coming from other applications or devices, this API procedure gives you the ability to enable or disable the media engine mechanism associated with inbound request authentication.

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


public VoipMediaEngine..::.TELEPHONY_RETURN_VALUE SetChallengeAuthenticationState(
	bool EnableState
Visual Basic (Declaration)
Public Function SetChallengeAuthenticationState ( _
	EnableState As Boolean _
Visual C++
VoipMediaEngine..::.TELEPHONY_RETURN_VALUE SetChallengeAuthenticationState(
	bool EnableState
public VoipMediaEngine..::.TELEPHONY_RETURN_VALUE SetChallengeAuthenticationState(
	boolean EnableState


Type: System..::.Boolean
If set to a nonzero value, your application will be sent the SipIncomingAuthentication event whenever SIP protocol messages of the following type are received: REGISTER, INVITE, BYE, SUBSCRIBE, and NOTIFY. Your application will also have access to data associated with the incoming protocol request as specified by the data in the VoipMediaEngine..::.CHALLENGE_AUTHENTICATION class object. Your application can then inspect the data in this class to determine if it wants to allow the media engine to challenge the incoming request. To disable incoming challenge related events, set this parameter to zero.

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)

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)



See Also