company logo

PropertyHandle :: GetText - Get text data

The function returns the text part for data stored as XML or HTML text. When the data does not contain XML or HTML, the function returns the same result as GetString().

Return value:  String containing the text ( NString & )

Implementation overview

Implementation details

  1. Get text for current property
    const NString & PropertyHandle  :: GetText ( NString &n_string )
    • n_string - - Title unknown
  2. to list
  3. Get text data for property
    const NString & PropertyHandle  :: GetText ( NString &n_string, NString &prop_path )

    The function returns the text data for the property referred to in property_path.

    • n_string - - Title unknown
    • 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

  4. to list