When incoming request authentication is enabled, the media engine uses random internally generated authentication data that is associated with the authentication challenge. This time varying data is used internally and is not known by your application. It is used to give the Digest authentication mechanism additional means by which to enhance access protection and session security. If you are familiar with "nonce" values and Digest authentication, you should assume this API procedure controls the "stale" nature of authentication parameters.

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

Syntax

C#
public VoipMediaEngine..::.TELEPHONY_RETURN_VALUE SetAuthCredentialExpireTime(
	uint ExpireTimeTimeSeconds
)
Visual Basic (Declaration)
Public Function SetAuthCredentialExpireTime ( _
	ExpireTimeTimeSeconds As UInteger _
) As VoipMediaEngine..::.TELEPHONY_RETURN_VALUE
Visual C++
public:
VoipMediaEngine..::.TELEPHONY_RETURN_VALUE SetAuthCredentialExpireTime(
	unsigned int ExpireTimeTimeSeconds
)
J#
public VoipMediaEngine..::.TELEPHONY_RETURN_VALUE SetAuthCredentialExpireTime(
	UInt32 ExpireTimeTimeSeconds
)

Parameters

ExpireTimeTimeSeconds
Type: System..::.UInt32
This value specifies the number of seconds that is used to compute random internally generated authentication credential data. Setting this value too small will tend to increase network traffic due to far end devices using "stale" nonce credential data, thus forcing additional rounds of challenge requests. Setting this value to large numbers is acceptable and has no ill effect. The internal default value for this parameter is 60 seconds.

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)

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