Cisco Cisco Computer Telephony Integration Option 9.0 Developer's Guide
7-3
CTI OS Developer’s Guide for Cisco ICM/IPCC Enterprise & Hosted Editions
Cisco CTI OS Release 7.2(1)
Chapter 7 CtiOs Object
Methods
COM:
HRESULT GetAllProperties (/*[out]*/ IArguments** arguments, /*[out,retval]*/
VARIANT_BOOL* errorcode)
VB:
GetAllProperties arguments As (CTIOSCLIENTLib.IArguments) As Bool
Java, .NET:
Arguments GetAllProperties()
Parameters
C++, COM, VB: arguments
Output parameter in the form of an arguments array that has all of the property names and values of
the object.
the object.
errorcode
An output parameter (return parameter in VB) that contains a boolean indicating success or lack
thereof.
thereof.
Return Value
C++ , VB: True upon success and false upon failure.
COM: Always returns S_OK. The errorcode parameter should be used to determine success or failure
of the method call.
of the method call.
.NET, Java: NULL if the value requested is not found or if there is an error. If the method succeeds, it
returns a reference to an Arguments object containing all of the properties of the object.
returns a reference to an Arguments object containing all of the properties of the object.
GetElement
Given a property of type Arguments whose name is specified by the key parameter, the GetElement
method returns the Arg at position element of that Arguments array.
method returns the Arg at position element of that Arguments array.
Syntax
C++:
Arg& GetElement (string& key, int element)
Arg& GetElement (int key, int element)
Arg& GetElement (char* key, int element)
COM:
HRESULT GetElement /*[in]*/ VARIANT* key, /*[in]*/ int element, /*[out,retval]*/
IArg** pIArg)
VB:
GetElement (key As VARIANT) As CTIOSCLIENTLib.IArg
Java:
Arg GetElement(String key, int element)
Arg GetElement(int key, int element)
.NET:
System.Boolean GetElement(System.String key, int element, out arg rArg)
Parameters
key
A key designating the name of the Arguments property whose element you want.
element
The integer index of the element to retrieve from the property key.
COM, VB:pIArg
An output parameter (return parameter in VB) containing an IArg with the value of the desired
element.
element.