Home > Language Reference > Classes > XmlParser

UserData Property

User data associated with a tag.

Syntax

Public Property Get UserData(ByVal iDepth As Integer) As Long
Public Property Let UserData(ByVal iDepth As Integer, ByVal lData As Long)

Remarks

The UserData property lets you associate user data to a tag. Calling this property is only meaningful while parsing a document, that is while processing the StartElement, EndElement and CharData events. In any other circumstance, it raises a runtime error.

The iDepth parameter specifies the tag to which associate user data. The value 0 refers to the tag at the top of the parser stack, that is the tag being currently analysed; the value 1 refers to the tag one level deeper, that is the tag surrounding the current tag; and so on. Therefore the iDepth parameter must lie between zero and the current height of the XML tree minus one, otherwise a runtime error occurs.

By default, no user data is associated to tags on the parser stack, and this property returns zero.

System requirements