PropertyHandle :: GetString - Get string
The function returns the property content as 0-terminated string. When the property is a text type property (IsText()), the function returns the text from the property. Otherwise the data is converted into text data before being returned.
The function stores the result in a work buffer of the property handle. This available until the next function call with this property handle.
Implementation overview
- Get string for current property
PropertyHandle :: GetString ( ) - Get string for a property
PropertyHandle :: GetString ( sprop_path )
Implementation details
-
Get string for current property
const NString PropertyHandle :: GetString ( )
The function returns the string value for the current property.
to list
-
Get string for a property
const NString PropertyHandle :: GetString ( NString &sprop_path )
The function returns the string text for the property referenced in the property path.
- sprop_path
- Simple 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. A simple property path must not contain parentheses or preceding dots.
to list
- sprop_path
- Simple property path