The GetRegistationTimeOut procedure returns to the caller the registration timeout
value in milliseconds. The registration timeout value is used by the media engine
to detect registration timeouts. If the media engine attempts a registration to a
server and does not receive a response within the set registration timeout value,
a SipRegistrationTimeOut event will be sent to the application.
Namespace:
LanScapeAssembly: LMEVoipManaged (in LMEVoipManaged.dll) Version: 6.0.5226.26700
Syntax
| C# |
|---|
public VoipMediaEngine..::.TELEPHONY_RETURN_VALUE GetRegistationTimeOut( ref uint TimeOutMs ) |
| Visual Basic (Declaration) |
|---|
Public Function GetRegistationTimeOut ( _ ByRef TimeOutMs As UInteger _ ) As VoipMediaEngine..::.TELEPHONY_RETURN_VALUE |
| Visual C++ |
|---|
public: VoipMediaEngine..::.TELEPHONY_RETURN_VALUE GetRegistationTimeOut( unsigned int% TimeOutMs ) |
| J# |
|---|
public VoipMediaEngine..::.TELEPHONY_RETURN_VALUE GetRegistationTimeOut( /** @ref */UInt32 TimeOutMs ) |
Parameters
- TimeOutMs
- Type:
System..::.UInt32
%
The current registration timeout value in milliseconds.
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 |
|---|---|
| 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
