company logo

PropertyHandle :: GetIdentity - Get property identity string

The function builds an identity string for a property in a structure instance:

loid | property_path [ index ]

The identifier string is a local database identity (LOID) for the instance. property_path is the path that identifies a property within the instance. When the property is an array the element position is indicated by the index. Index numbers may also appear within the path (e.g. when supporting up to three addresses for a person a property path for 'place" could look like:

199879899|address[2].place

The identity string is returned in an internal area when no area is passed ( id_string ). Otherwise the area passed in string should have 513 bytes, but at least the maximum expected string size +1.

If there is no instance selected in the (upper) collection property handle the function returns NULL. If no id_string is passed the function returns the path in communication area of the property handle. This area is destroyed when calling the next PropertyHandle function.

Return value:  Identity string ( NString & )

Implementation details

const NString & PropertyHandle  :: GetIdentity (  )