National Instruments 320682C

Chapter 9 X Property Library

There are three predefined property types that you do not need to create using this function.

These types, listed below, are useful for defining properties to store window IDs, integers and

strings.

Property Type Name Size/Unit

WINDOW_X_PROP_TYPE "WINDOW" sizeof(WindowX)

INTEGER_X_PROP_TYPE "INTEGER" sizeof(int)

STRING_X_PROP_TYPE "STRING" sizeof(char)

Note: You can create a maximum of 64 different property types.

Parameters

Input typeName string Name of the property type. Each

property type name is unique and has

one set of attributes, which cannot be

changed after you create the property

type.

size unsigned integer Number of bytes in a single property

item.

unit unsigned integer Number of bytes in the basic units that

make up a property item.

Output propertyType PropTypeHandleX

(passed by reference) Property type created. Use this value as

the type parameter to

CreateXProperty to create

properties.

Return Values

The return value indicates the success or failure status of the function call. A negative value

indicates an error. status values are shown in the following table.

NoXErr 0 The function was successful.

InvalidParamXErr -1 NULL was passed to one or more of the parameters; size

argument is 0; unit is not 1, 2, or 4; or size is not a multiple

of unit.

DupPropTypeXErr -9 A property type with the same typeName, but with

different size or unit already exists.

InsuffMemXErr -19 There is insufficient memory to store the property

information or there are already 64 property types.