DeleteUserAttribute

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

The DeleteUserAttribute transaction removes the specified user attribute from the specified document, page, or layer.

Type XTYP_EXECUTE

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

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

Remarks

pageID and layerID are optional parameters. To delete a user attribute attached to a document, or a system attribute, specify the docwinID only. To delete 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.

Release information

Added in Release 3.81.

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