PrgItemUserDataFindFirst Method

Description

Finds the first user data pair from the list of key value pairs for a specific element for the specific layer.

Syntax

Visual Basic
Public Sub PrgItemUserDataFindFirst( _ ByVal layerHandle As Long, _ ByVal seqNum As Long, _ ByRef pKey As String, _ ByRef pValue As String _ )

Parameters

layerHandle: The handle of a layer returned by the CreateLayer method.
seqNum: The handle of an element returned by the ElementAppend method.
pKey: The address of a string to receive the first key from the list of key value pairs.
pValue: The address of a string to receive the first value from the list of key value pairs.

Remarks

Element User Data is two text fields called key and value (a map). These are allocated by each element and reserved for use by the application to store a private key value pair to associate to an element.

User data can be programmatically modified or added via the NX_XML file format

User data may be associated with an element, group, layer, or page