company logo

PropertyHandle :: ExtractCurrentKey - Extract ident-key from the currently selected instance

The function extracts the identifying key value according to the structure definition of the currently selected instance. For weak-typed collections this may differ from the identifying keyfor the data type defined as base type for the collection.

When a key area has been passed in the key parameter the function returns the key in the passed key area. When no key or an empty key has been passed the returned key area refers to an internal area, which should not be modified by the application. This area is valid until the next ODABA interface function has been called.

For fixed typed properties the function works similar to ExtractKey().

Return value:  Key value ( ::Key  )

The key is provided in the internal key format. When necessary the key value can be converted from a string into the internal format using the StringToKey() function.

Implementation details

::Key PropertyHandle  :: ExtractCurrentKey ( ::Key ident_key_w=Key() )
  • ident_key_w - Ident key value

    The key is provided in the internal key format. When necessary the key value can be converted from a string into the internal format using the StringToKey() function.

    Default: Key()