GetUserAttribute

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

The GetUserAttribute transaction returns the value of the specified user attribute. This can be a predefined attribute, or one set by the integration using SetUserAttribute.

Type XTYP_REQUEST

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

Parameter	Data type	Values	Meaning
docwinID	DWORD	-1	system attribute--attribute available to all documents
		0	attribute attached to the active document
		docwinID	attribute attached to the specific document
pageID	DWORD	0 \| pageID	current \| specific. See Remarks.
layerID	DWORD	identifier of the layer to query. See Remarks.
attributeName	string	description of the user attribute
Reply	Data type	Meaning
value	string	value of the user attribute

Remarks

pageID and layerID are optional parameters. To return a global attribute or a user attribute attached to a document, specify the docwinID only. To return a user attribute attached to a page, specify the docwinID and pageID only. Only if the user attribute is attached to a layer are all four parameters required.

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

Release information

Added in Release 3.81.

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