Cisco Cisco Computer Telephony Integration OS 8.5 Developer's Guide

Page of 546
 
12-23
Cisco ICM Software CTI OS Developer’s Guide Release 6.0(0)
 
Chapter 12      Helper Classes
Arguments Class
String    GetValueString(int iKey)
String    GetValueString(String sKey)
Parameters
An enumerated keyword (see 
) or a string specifying the keyword of the value to be retrieved.
Return Values
C++ returns a Bool or the a reference to the value, COM returns an HRESULT. 
See also 
Remarks
Visual Basic's Integer type is a 16-bit integer. However, the GetValueInt method 
returns a 32-bit integer. Thus, in Visual Basic the return type for GetValueInt is 
actually a Visual Basic type Long. Visual Basic Programmers can use the 
GetValueInt method and receive the return value as an Integer, and Visual Basic 
will perform an implicit cast. However, if the value retrieved is a 32-bit integer, 
an overflow error will occur. To resolve this error, it is recommended that you use 
a 32-bit integer (Long).
Those methods that do not return a bool indicating success or failure will throw a 
CtiosException if the method fails. The most common reasons for failure are 
NULL key or element with specified key not found.
IsValid
The IsValid method returns True if the specified key exists in the current 
Arguments array, otherwise it returns False.
Syntax
C++: 
bool IsValid( std::string& key );
bool IsValid( char * key );
bool IsValid( Arg& arg );
bool IsValid( enum_Keywords key );