Cisco Cisco Computer Telephony Integration Option 9.0 Developer's Guide

Page of 546
 
12-11
Cisco ICM Software CTI OS Developer’s Guide Release 6.0(0)
 
Chapter 12      Helper Classes
Arguments Class
errorcode
An output parameter (return parameter in VB) that contains an error code 
from 
 in 
Return Values
C++
If the method was able to set the value it returns true, otherwise it returns false.
COM, VB
If the method was able to set the value it returns VARIANT_TRUE. Otherwise, 
it returns VARIANT_FALSE.
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 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.