StopSipTelephony

 

The StopSipTelephony function allows you to terminate all operations of the telephony engine. If any calls are active, they are properly terminated before the telephony engine performs its shut down. Once this procedure is called, no other telephony operations are possible using the specified handle.

 

 

TELEPHONY_RETURN_VALUE StopSipTelephony(

SIPHANDLE hStateMachine

);

 

 

 

Parameters:

 

hStateMachine

[in] The handle to the telephony engine. This is the handle that was returned by a previous call to the StartSipTelephony procedure.

 

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 TELEPHONY_RETURN_VALUE data type.

 

 

 

Value

Description

SipInvalidHandle

An API procedure was passed an invalid handle. The telephony engine attempts to verify user specified telephony handles and returns this error when an invalid handle is detected.

 

SipCallFailure

This is a generic "catch all" API error. If an error condition is not specified by any other API error value, this error will be returned.