Cisco Cisco Computer Telephony Integration Option 9.0 Developer's Guide

Page of 500
   
10-10
CTI OS Developer’s Guide for Cisco Unified ICM/Contact Center Enterprise & Hosted
Release 7.5(1)
Chapter 10      Call Object
Methods
int Clear(Arguments & reserved_args);
COM:
HRESULT Clear (/*[in,optional]*/  IArguments *reserved_args,    (/*[out, retval]*/ 
int * errorcode )
VB:
Clear([reserved_args As IArguments]) As Long
Java:
int Clear(Arguments rArgs);
.NET:
CilError Clear(Arguments args);
Parameters
reserved_args
Not currently used, reserved for future use.
errorcode
An output parameter (return parameter in VB) that contains an error code from 
 in 
.
Return Value
Default CTI OS return values. See 
Remarks
In the case of a multi-party Conference call, calling Clear() will result in all of the parties to the call 
being hung up. (If this is not the desired behavior, see the ClearConnection method.) Under certain 
switches the Clear request will be made via a call whose status is LCS_CONNECT or LCS_INITIATE 
or it will fail. Many other switches will allow the Clear method to be called via a call whose status is 
LCS_ALERTING or LCS_HOLD. It may never be made via a call whose status is LCS_NULL 
indicating that it has already been cleared. 
The following events will be received  if this request is successful: 
OnClearCallConf event
OnCallCleared event
The following events will be received  if this request fails: 
OnControlFailureConf event
Note
The Clear method is not supported on IPCC. Use of the Clear method with IPCC will result in loss of 
third-party call control. To avoid this error, applications should use the ClearConnection method instead 
of Clear to hang up a call.
ClearConnection
If there are only two parties to the call, ClearConnection effectively clears the call. However, for a 
multi-party conference call, only the one connection is dropped, which will be its own connection.
Syntax
C++:
int ClearConnection()
int ClearConnection(Arguments & reserved_args);