Related Functions
Example All Editions
Related Functions
Example
The IN_SetUserAttribute function attaches a user attribute to the specified document, page, or layer, or globally to Imagenation. User attributes are always stored as text, and can contain any data meaningful to the integration, such as a database identifier. There is no limit to the number of user attributes that can be stored with an object or in the product.
Syntax
int IN_SetUserAttribute( objectID, pAttributeName, dataSize, pAttributeData )
|
Parameters |
Values |
Meaning |
|
IN_OBJECT objectID |
IN_SYSTEM_OBJECT (-1) objectID identifier of the document, page, or layer to attach the attribute to | |
|
CHARPTR pAttributeName |
pointer to the name of the attribute. See Remarks. | |
|
SHORT dataSize |
size of the attribute value string | |
|
CHARPTR pAttributeData |
pointer to the data that the attribute contains | |
Remarks
The "UserID" user attribute is predefined and can be assigned a value. For more information about it and other predefined attributes, 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.
Attributes that are set by the user are treated as a "black box"--the object is stored, but will not be manipulated in any way.
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