SetUserAttribute

All Editions $image\bltlrgss.gif$ Related Transactions $image\bltlrgss.gif$ Example

The SetUserAttribute transaction attaches a user attribute to the specified document, page, or layer. User attributes are always string data types, 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 within an object or in the product.

Type XTYP_EXECUTE

Syntax [SetUserAttribute(docwinID, <pageID>, <layerID>, "attributeName", "value")]

Parameter	Data type	Values	Meaning
docwinID	DWORD	-1	system attribute
		0	active document
		docwinID	specific document
pageID	DWORD	0 \| pageID	current \| specific. See Remarks.
layerID	DWORD	0 \| layerID	active \| specific. See Remarks.
attributeName	string	description of the attribute
value	string	value of the attribute

Remarks

pageID and layerID are optional parameters. If you specify docwinID only, then the user attribute is a system attribute (generally available) or is attached to the specified document. If you specify docwinID and pageID only, the user attribute is attached to the page. Only if the user attribute is attached to a layer are all four parameters required.

The "UserID" user attribute is predefined and can be assigned a value. For more information about it and other predefined attributes, see Predefined user attributes.

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 in Release 3.81.

Modified in Release 4.5 to allow for the use of system (global) attributes.