Cisco Cisco Computer Telephony Integration Option 8.5 Developer's Guide

Page of 490
   
7-7
CTI OS Developer’s Guide for Cisco Unified Contact Center Enterprise
Release 8.5(3)
Chapter 7      CtiOs Object
Methods
GetValue
The GetValue method returns the value of the specified property. Use this method if you do not know 
the type of the property. Otherwise, use the more specific GetValue methods discussed later in this 
chapter. When using the COM CIL, do not use this method for properties of type IDispatch*; instead, 
use GetCurrentCall, GetCurrentAgent, GetAllCalls, GetAllAgents, and GetAllSkillGroups as explained 
in 
Syntax
C++:
Arg& GetValue (string& key)
Arg& GetValue (int key)
Arg& GetValue (char* key)
COM:
HRESULT GetValue (/*[in]*/ VARIANT* key, /*[out,retval]*/ IArg** value)
VB:
GetValue (key As VARIANT) As CTIOSCLIENTLib.IArg
Java:
Arg  GetValue( String key )
Arg& GetValue (int key)
.NET
virtual System.Boolean GetValue(Enum_CtiOs eKeyID, out Arg obArg)
virtual System.Boolean GetValue(System.String sKey, out Arg obArg)
Parameters
key
The name of the property whose value you want.
COM: value
An output value of type Arg** containing the property with the designated name. To get the value 
of the property, call GetType() on the Arg and then call the specific GetValue method, based on the 
type.
.NET: obArg
Output parameter (return value in C++, VB, and Java) containing the specified property, as 
described in the explanation of the value parameter.
Return Value
COM:
 
Default HRESULT return value. See 
.NET: Returns true if the value is retrieved, and false if the value is not found.
Others: An Arg containing the specified property. To get the value of the property, call GetType() on the 
Arg and then call the specific GetValue method, based on the type.
GetValueArray
The GetValueArray method returns the Arguments array value of the specified property. Use this method 
when you know that the property is of Arguments array type, such as ECC call variables.
Syntax
C++:
Arg& GetValueArray (string& key)
Arg& GetValueArray (enum_Keywords key)