company logo

PropertyHandle :: GetKeySMCB - Get identifying key definition

The function returns the structure definition for a key definition of the structure defined for the property handle. This is not necessarily an index or sort key of the collection referenced by the property handle.

When no key is passed the function returns the key definition of the identifying key. For weak-typed collections, this is not the identifying key for the currently selected instance, but the identifying key defined for the data type the collection is based on. for retrieving the identifying key definition for the currently selected instance, one may call GetCurrentKeySMCB().

Return value:  Pointer to general structure definition ( smcb * )

The smcb is general way to define any type of structure. It contains information for the structure and its properties. The definition does contain only descriptive information (no access information).

Implementation details

smcb * PropertyHandle  :: GetKeySMCB ( NString &key_name_w=NString::Null() )
  • key_name_w - Key name for conversion Default: NString::Null()