company logo

PropertyHandle :: GetStringValue - Get property instance as string value

The function returns the string value for the current property handle or for the attribute passed in prop_path. In addition to explicit properties defined for the structure of the instance "__LOID" and "__GUID" can be passed as property path (prop_path) for retrieving the local object identifier and the global unique identifier for the instance.

In contrast to GetString() the no instance must be selected in the property handle.
Return value:  String containing the text ( NString & )

Implementation overview

Implementation details

  1. - internal feature (not documented)
    NString PropertyHandle  :: GetStringValue (  )
    2. to list
  2. - internal feature (not documented)
    NString PropertyHandle  :: GetStringValue ( NString &prop_path )
    • prop_path - Property path

      A property path is passed as 0-terminated string. It may contain an extent or property name but also a sequence of property names separated by dot.

      Property path may start with a dot (.), which indicates, that the path starts in an upper property handle. One dot indicates, that the path starts in the current property handle. This distinction becomes necessary, when a property has the same name as an extent. To access the property in this case, one dot must precede the property name. The first dot can be omitted, when the property name is not an extent name.

      Referring to a path starting in a parent property handle requires two dots (..), the parents parent three and so on.

      address.street

      .address.street
    3. to list
to top previous next upper table of contents Comment