If your application will be challenged by other telephony software or devices, you can use this API procedure
to remove authorization credentials that were previously set using the AddAuthorizationCredentials(String, String, String)
API procedure. After you call this procedure, the specified authorization credentials are removed from the
internal list maintained by the media engine.
Namespace:
LanScapeAssembly: LMEVoipManaged (in LMEVoipManaged.dll) Version: 6.0.5226.26700
Syntax
C# |
---|
public VoipMediaEngine..::.TELEPHONY_RETURN_VALUE DeleteAuthorizationCredentials( string UserName, string Password, string Realm ) |
Visual Basic (Declaration) |
---|
Public Function DeleteAuthorizationCredentials ( _ UserName As String, _ Password As String, _ Realm As String _ ) As VoipMediaEngine..::.TELEPHONY_RETURN_VALUE |
Visual C++ |
---|
public: VoipMediaEngine..::.TELEPHONY_RETURN_VALUE DeleteAuthorizationCredentials( String^ UserName, String^ Password, String^ Realm ) |
J# |
---|
public VoipMediaEngine..::.TELEPHONY_RETURN_VALUE DeleteAuthorizationCredentials( String UserName, String Password, String Realm ) |
Parameters
- UserName
- Type: System..::.String
A user name that is used to authenticate with the far end challenging entity.
- Password
- Type: System..::.String
A password that was used to authenticate with the far end challenging entity.
- Realm
- Type: System..::.String
The name of the realm that was being challenged.
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 Value | Description |
---|---|
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.