National Instruments 320682C Musical Toy Instrument User Manual


 
Chapter 9 X Property Library
© National Instruments Corporation 9-19 LabWindows/CVI Standard Libraries
GetXPropTypeUnit
PropLibXErrType
status = GetXPropTypeUnit
(PropTypeHandleX
propertyType
,
unsigned
int
*
unit
)
;
Purpose
Get a property type unit.
This function returns the unit associated with the property type. The unit is the number of bytes
(1, 2, or 4) in the basic objects that make up a property item.
Parameters
Input
propertyType
PropTypeHandleX
Handle to property type for which the unit is
to be obtained. This value must either be one
of the predefined property types or be a value
returned by CreateXPropType.
Output
unit
unsigned integer
(passed by
reference)
The
unit
associated with the property type.
The unit is the number of bytes (1, 2 or 4) in
the basic objects that make up a property item.
Return Values
The return value indicates the success or failure status of the function call. A negative value
indicates an error.
The following table shows
status
values.
NoXErr
0 The function was successful.
InvalidParamXErr
-1
NULL was passed to the
unit
parameter.
InvalidPropTypeXErr
-5
The
propertyType
argument is not a valid property type.
This value must either be one of the predefined property
types or be a value returned by CreateXPropType.
See Also
CreateXPropType