Cisco Cisco Computer Telephony Integration Option 8.5 Developer's Guide

Page of 508
   
12-4
CTI OS Developer’s Guide for Cisco Unified ICM/Contact Center Enterprise & Hosted
Release 8.0(1)
Chapter 12      Helper Classes
Arg Class
Parameters
arg
(output) Pointer to the newly created Arg.
Return Values
COM: Default HRESULT return values. See 
Others: Either a reference to the newly created Arg or a boolean indicating method success. If the 
methods not returning bool are unsuccessful, they will raise a CCtiosException with iCode set to 
E_CTIOS_ARGUMENT_ALLOCATION_FAILED.
Remarks
This method increments the Arg’s reference count, so do not call AddRef(). However, you must call 
Release() after you are finished with the Arg.
DumpArg
The DumpArg method builds a string containing the value stored in the Arg. This involves doing any 
type conversion required to display the data as a string. For example, it will automatically convert an 
INTEGER type to a string that can be logged for debugging. In the event that a Arg object is actually an 
Arguments object, the string returned is the one built by Arguments.DumpArg, and thus enabled printing 
of nested Arguments structures. 
Syntax
C++:
string DumpArg()
COM:
 HRESULT DumpArg([out,retval] BSTR* arg_string);
VB:
DumpArg() as String
Java, .NET:
Not available. Use the ToString method.
Parameters
arg_string
The pointer to the string into which the contents of the Arg object will be written.
Return Values
COM: Default HRESULT return values. See 
Others: A string containing the contents of the structure.
GetArgType (.NET only)
The GetArgType method returns the type of the contained value. This returned value will be one of the 
following: