When initiating out bound calls, your application will be notified when authentication challenges fail and your phone
call can not be completed. If this is the case, then your application may receive one of the following phone
line events:
Namespace:
LanScape
SipOutgoingCallDigestAuthenticationRequired
SipOutgoingCallBasicAuthenticationRequired
SipOutgoingCallUnsupportedAuthentication
When your application processes these events, you can call the GetChallengeErrorData(Int32, VoipMediaEngine..::.CHALLENGE_ERROR_DATA) API procedure to obtain the challenge error data. Applications use this challenge error data to display "authorization required" messages to users.
Assembly: LMEVoipManaged (in LMEVoipManaged.dll) Version: 6.0.5226.26700
Syntax
| C# |
|---|
public VoipMediaEngine..::.TELEPHONY_RETURN_VALUE GetChallengeErrorData( int PhoneLine, VoipMediaEngine..::.CHALLENGE_ERROR_DATA ChallengeErrorData ) |
| Visual Basic (Declaration) |
|---|
Public Function GetChallengeErrorData ( _ PhoneLine As Integer, _ ChallengeErrorData As VoipMediaEngine..::.CHALLENGE_ERROR_DATA _ ) As VoipMediaEngine..::.TELEPHONY_RETURN_VALUE |
| Visual C++ |
|---|
public: VoipMediaEngine..::.TELEPHONY_RETURN_VALUE GetChallengeErrorData( int PhoneLine, VoipMediaEngine..::.CHALLENGE_ERROR_DATA^ ChallengeErrorData ) |
| J# |
|---|
public VoipMediaEngine..::.TELEPHONY_RETURN_VALUE GetChallengeErrorData( int PhoneLine, VoipMediaEngine..::.CHALLENGE_ERROR_DATA ChallengeErrorData ) |
Parameters
- PhoneLine
- Type: System..::.Int32
The zero based phone line to access.
- ChallengeErrorData
- Type: LanScape..::.VoipMediaEngine..::.CHALLENGE_ERROR_DATA
A reference to a variable of type VoipMediaEngine..::.CHALLENGE_ERROR_DATA. When this API procedure is called, this variable will be initialized with authentication error data.
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) |
| 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) |
| 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) |
| 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
