Name
GetNthProperties
Description
HRESULT
GetNthProperties([in] LONG index,
[in] VARIANT propertyIDs,
[in,out] VARIANT* propertiesArray,
[out,retval] ULONGLONG* error);
Retrieves the property at a specific index in a list.
You can use this to iterate through returned property lists.
Parameters
- index
-
Index into the property list of the job object.
- propertyIDs
-
An array of propertyIDs to identify the properties
to fetch.
- propertiesArray
-
An array that returns the properties
identified by the array "propertyIDs". Each
element in "propertiesArray" matches the
corresponding indentifier in "propertyIDs";
for example, if the first element in the "propertyIDs" array
is VixCOM.Constants.VIX_PROPERTY_JOB_RESULT_HANDLE,
the first element in "propertiesArray" will be the
object that is the result of this job, if one exists.
- error
-
This returns VIX_OK if the method call succeeded, otherwise the
return value indicates an error.
Return Value
HRESULT
Remarks
Side Effects
None.
Requirements
VixCOM.h, since VMware Workstation 6.0.
Example
Copyright (C) 2007 VMware, Inc. All rights reserved.