IN_GetUserAttribute

All Editions $image\bltlrgsq_shg.gif$ Related Functions $image\bltlrgsq_shg.gif$ Example

The IN_GetUserAttribute function returns the value of the specified user attribute for the specified document, page, or layer, or globally for Imagenation.

Syntax

int IN_GetUserAttribute( objectID, attributeID, maxSize, pAttributeData )

Input Parameters	Values	Meaning
IN_OBJECT objectID	IN_SYSTEM_OBJECT (-1) system attribute--attribute available to all documents objectID identifier of the document, page, or layer to query
CHARPTR attributeID	attribute identifier. See Remarks.
SHORT maxSize	the maximum size of the pAttributeData array in bytes
Output Parameters	Meaning
CHARPTR pAttributeData	pointer to the value of attributeID

Remarks

Some user attributes are predefined, and can be requested. For information about these, click Predefined user attributes.

The predefined user attribute called "UserID" can only be returned or set using IN_SYSTEM_OBJECT (-1) as the objectID. You cannot use a pageID or layerID for this attribute.

Release information

Added to Imagenation for Windows in Release 4.00.

Modified in Release 4.5 to support system attributes.

As of Release 5.1, also available in Imagenation for UNIX.

See also

Setting user attributes