company logo

PropertyHandle :: FixKeyComponents - Fix key component values

The function fixes a number of high level key component values, i.e. it acts like a filter, which requires certain values for a number of top key components. Similar to a filter condition, the function reduces the number of instances, which can be read via the property handle. You may call Position() or GetRelative() in order to read consecutive instances from the restricted collection. GetRelativeCount() returns the instance count in the restricted collection.

In order to reset fixed key components one may call the function with switch level AUTO or without parameters.

The function reset previous key selections or implicitly defined key selections (e.g. when opening a property path. The function does work on regular collections, only, i.e. on persistent or transient collections with defined sort orders (indexes). Key selections are reset automatically, when changing the sort order.

Return value:  Success ( logical  )

Implementation overview

Implementation details

  1. - internal feature (not documented)
    logical PropertyHandle  :: FixKeyComponents ( int16 kc_level=AUTO, ::Key sort_key_w=Key() )
    • kc_level - Number of fixed key component Default: AUTO
    • sort_key_w - Sort 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()
  2. to list
  3. - internal feature (not documented)
    logical PropertyHandle  :: FixKeyComponents ( NString &cnkey, int16 kc_level=AUTO )
    • cnkey - - Title unknown
    • kc_level - Number of fixed key component Default: AUTO
  4. to list