Cisco Cisco Computer Telephony Integration Option 8.5 Developer's Guide

Page of 506
   
10-15
CTI OS Developer’s Guide for Cisco Unified Contact Center Enterprise
Release 8.5(1)
Chapter 10      Call Object
Methods
Return Value
C++, COM, and VB: Default HRESULT return values. See 
Java/.NET: A reference to an Arguments array that, on return, holds parameters described under 
Remarks.
Remarks
This is simply a convenience method to be called to get all of a call’s CallVariables (1 through 10) and 
ECC Call Variables at one time. If only certain call variables are desired, call the appropriate GetValue 
method for each instead.
Access the data in the following way:
To access the values for individual CallVariables from the arguments parameter, use GetValueString 
with either the keywords of “CallVariable1” through ”CallVariable10”. 
To access ECC call data, use the following procedure:
First, get the ECC variables as a whole from the arguments parameter, using GetValueArray with 
the keyword “ECC’. This will return another Arguments array that is nested in the Arguments array 
returned from GetCallData.
To access an individual ECC scalar variable from this Arguments array, use the appropriate 
GetValueString, GetValueInt, etc. depending on the variable’s type, using the string keyword 
“user.VariableName”.
To access an individual ECC array variable from this Arguments array, use the appropriate 
GetValueString, GetValueInt, etc. depending on the variable’s type, using the string keyword 
“user.ArrayName[n] where n is a zero based integer that notes the offset in the array.
Hold
The Hold method holds a current call.
Syntax
C++:
int Hold()
int Hold(Arguments & reserved_args);
COM:
HRESULT Hold (/*[in,optional]*/  IArguments *reserved_args,    (/*[out, retval]*/ 
int * errorcode )
VB:
Hold([reserved_args As IArguments]) As Long
Java:
Arguments Hold(Arguments rArgs)
NET:
Arguments Hold(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