company logo

PropertyHandle :: GetSortKey - Get sort key name

The function returns the name of the currently selected index (sort key name). When the collection is not ordered or when the property handle does not refer to a collection, the function returns NULL.

Return value:  Name of sort key ( NString & )

The order key name must be a key name defined for the given structure. The sort key is passed as 0-terminated string with maximum 40 characters.

Implementation details

const NString & PropertyHandle  :: GetSortKey (  )