Cisco Cisco Computer Telephony Integration Option 9.0 Developer's Guide

Page of 640
12-13
CTI OS Developer’s Guide for Cisco ICM/IPCC Enterprise & Hosted Editions Release 7.0(0)
 
Chapter 12      Helper Classes
Arguments Class
Arguments Class
The Arguments structure (class) provides key/value support to form a collection 
of values. Each value stored in an Arguments structure is associated with a key. 
To add an item, use the AddItem or SetValue method and pass a key and a value. 
The key must be a string or an enumerated value, and the value can be almost any 
type (i.e. all types supported by Arg). To retrieve the item, use the appropriate 
GetValue method with a key, and the value is returned. Keys are not case sensitive, 
and leading and trailing spaces are always removed from the key. 
Arguments also supports access by index. The index is useful for retrieving items 
sequentially, but may not be as fast as retrieval by key. The Arguments structure’s 
index is 1-based, to provide easier support for Visual Basic programmers. 
Internally, the Arguments structure uses a binary tree and other techniques to 
provide fast access to any item. Arguments can support a virtually unlimited 
number of key-value pairs, and supports nested Arguments structure as well. 
 lists the Arguments class methods.
Table 12-5 Arguments Class Methods 
Method
Description
AddItem
Adds an item to an Arguments array.
AddRef
Increments the reference count for the 
data item.
Clear
Deletes all elements from an Arguments 
array.
Clone
Creates a copy of an Arguments array.
CreateInstance
Creates an Arguments array.
DumpArgs
Returns Arguments object as a string
GetElement (also GetElementInt, 
GetElementUInt, 
GetElementUShort, 
GetElementShort, GetElementBool, 
GetElementString, GetElementArg, 
GetElementKey 
GetElementArgType)
Returns the value stored under a specified 
index.