Cisco Cisco Computer Telephony Integration Option 8.5 Developer's Guide

Page of 490
   
12-15
CTI OS Developer’s Guide for Cisco Unified Contact Center Enterprise
Release 8.5(3)
Chapter 12      Helper Classes
Arguments Class
The pointer to the string containing the contents of the Arguments array listing all of the key/value 
pairs in the format of “key1 = value1; key2 = value2;...”.
Return Values
COM: Default HRESULT return values. See 
Others: A string containing the contents of the Arguments array listing all key/value pairs. 
GetElement Methods
The 
GetElement method is similar to GetValue, except that it uses an index value instead of a key. The 
index value is not related to the order in which items are added or removed. The order of items in 
Arguments is never guaranteed. This method is useful for sequentially iterating over all items in 
Arguments. The Index is 1-based. The Index should never be less than one or greater than NumElements. 
see also NumElements method. The GetElementKey returns the key of a given index.
Syntax
C++: 
Arg& GetElement( int index );
bool GetElement( int index, Arg ** value);
int GetElementInt( int index );
bool GetElementInt( int index, int * value);
unsigned int GetElementUInt( int index );
bool GetElementUInt( int index, unsigned int * value);
unsigned short GetElementUShort( int index );
bool GetElementUShort( int index, unsigned short * value );
short GetElementShort( int index );
bool GetElementShort( int index, short * value);
bool GetElementBool( int index );
bool GetElementBool( int index, bool * value);
std::string GetElementString( int index );
bool GetElementString( int index, std::string * value);
Arguments& GetElementArg( int index );
bool GetElementArg( int index, Arguments ** key);
std::string GetElementKey( int index );
bool GetElementKey( int nIndex, std::string * key);
bool GetElementKey( int nIndex, int * key);
COM:
HRESULT GetElementKey(/*[in]*/ int index, /*[out]*/ BSTR *
key);
HRESULT GetElement(/*[in]*/ int index, /*[out]*/ VARIANT *
value);
VB:
GetElement (Integer index, Variant value)
GetElement (Integer index, String key)
Java:
Arg GetElement(int iIndex)
Arguments GetElementArguments(int iIndex)
Integer GetElementIntObj(int iIndex)
Long GetElementUIntObj(int iIndex)
Short GetElementShortObj(int iIndex)
Integer GetElementUShortObj(int iIndex)
Boolean GetElementBoolObj(int iIndex)
String GetElementString(int iIndex)
String GetElementKey(int iIndex)
.NET:
Boolean GetElement(System.Int32 iIndex, out Arg obArg)
Boolean GetElementInt(System.Int32 iIndex, out System.Int32
iValue )
Boolean GetElementUInt(System.Int32 iIndex, out System.Int64
nValue)