Cisco Cisco Computer Telephony Integration Option 8.5 Developer's Guide

Page of 546
 
8-29
Cisco ICM Software CTI OS Developer’s Guide Release 6.0(0)
 
Chapter 8      Session Object
Methods
errorcode
An output parameter (return parameter in VB) that contains an error code 
from 
 in 
Return Values
If the SetAgent request is successful, it returns a CIL_OK CtiOs_Enums.CilError 
code and fires an OnSetAgentMode event to the client application.
In Java only, if SetAgent () is called on a session where the current agent is different 
from the agent that SetAgent is trying to set, the following occurs:
The CIL automatically does a Disconnect on the current session object to 
Reset an agent.
An OnCloseConnection event is received.
A Connect is then performed.
AnOnConnection event is received, and the new agent is set.
In Java only, if the SetAgent request is unsuccessful it returns one of the following 
CtiOs_Enums.CilError codes:
E_CTIOS_INVALID_SESSION -- if session is not connected. 
E_CTIOS_PROP_ATTRIBUTES_ACCESS_FAILED -- if unable to get the 
connection mode property
E_CTIOS_SET_AGENT_SESSION_DISCONNECT_REQUIRED -- if 
SetAgent request was during a Monitor Mode session. The client application 
will need to call Disconnect first to clean up the connection mode and then 
call Connect again.
E_CTIOS_AGENT_ALREADY_IN_SESSION -- if the agent is already 
assigned to the session object. The client application will need to call 
Disconnect first to clean up the connection mode and then call Connect again.
E_CTIOS_ARGUMENT_ALLOCATION_FAILED -- if the application is 
unable to allocate memory.
E_CTIOS_PROP_ATTRIBUTES_ACCESS_FAILED -- if an error occurred 
while accessing agent properties.