If your application will be challenged by other telephony software or devices, you can use this API procedure to specify authorization data that will be used to fulfill the far end's authorization challenge. This API procedure can be called multiple times with different authentication data. The authentication data is then maintained internally by the media engine. As your application software executes, the media engine inspects its internal list of authentication credentials to locate credentials that will fulfill any authorization challenge that may occur.

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


public VoipMediaEngine..::.TELEPHONY_RETURN_VALUE AddAuthorizationCredentials(
	string UserName,
	string Password,
	string Realm
Visual Basic (Declaration)
Public Function AddAuthorizationCredentials ( _
	UserName As String, _
	Password As String, _
	Realm As String _
Visual C++
VoipMediaEngine..::.TELEPHONY_RETURN_VALUE AddAuthorizationCredentials(
	String^ UserName, 
	String^ Password, 
	String^ Realm
public VoipMediaEngine..::.TELEPHONY_RETURN_VALUE AddAuthorizationCredentials(
	String UserName,
	String Password,
	String Realm


Type: System..::.String
A user name that is used to authenticate with the far end challenging entity.
Type: System..::.String
A password that is used to authenticate with the far end challenging entity. This password is only known to your application and the far end. This password is also referred to as a "shared secret". The password specified here is never transmitted over the network when communicating with the far end applications or device.
Type: System..::.String
The name of the realm that will be challenged. If you are not familiar with the concept of a realm, simply think of it as being similar to a domain name. Each telephony application or device that challenges your application could all have unique realms assigned to them.

Specifying a "wild card" realm:

If the realm string specified for this parameter is set to the wild card string (a null terminated string that contains only an asterisk such as: "*", the wild card user name and password will be used to respond to authentication challenges from the challenging realms using the realm name that is specified in the received SIP challenge response.

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)



See Also