Name
VixPropertyList_AllocPropertyList
Description
VixError
VixPropertyList_AllocPropertyList(VixHandle handle,
VixHandle *resultHandle,
VixPropertyID firstPropertyID,
...);
This
function
creates a new VIX_HANDLETYPE_PROPERTY_LIST handle with a set of
properties on it. VIX_HANDLETYPE_PROPERTY_LIST handles are used to pass
extra arguments to many functions.
Parameters
- handle
-
Any valid handle.
- resultHandle
-
(output) A handle to the new property list.
- firstPropertyID
-
A property ID. See below for valid values.
Return Value
VixError. This function returns VIX_OK if it succeeded, otherwise
the return value indicates an error.
Remarks
- This function allows you to create a new property handle and set zero or more properties on it.
- This procedure accepts a variable number of parameters, so you can
set any number of properties with a single call. The parameters
must be in a series of pairs of property IDs and values.
Each value should be the type of the type of the property.
You end the variable
list of parameters with a single ID value of VIX_PROPERTY_NONE.
Side Effects
None.
Requirements
vix.h, since Workstation 6.5
Example