company logo

PropertyHandle :: SetKey - Move ident key value to instance

The passed key value is stored to the component attributes of the identifying key in the instance. When passing an empty instance the key is stored in the selected instance of the property handle. When no instance is passed or selected or when no identifying key is defined for the structure the function returns an error (YES).
Return value:  Success ( logical  )

Implementation overview

Implementation details

  1. - internal feature (not documented)
    logical PropertyHandle  :: SetKey ( ::Key ident_key, ::Instance instance )
    • ident_key - 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.
    • instance - Instance area

      Instances do have the type of the referenced property handle (collection type). The instance contains a pointer to a properly structured instance area.

      You can use the !-operator or the GetData() function to check whether the instance refers to data or not.
    2. to list
  2. - internal feature (not documented)
    logical PropertyHandle  :: SetKey ( ::Key ident_key )
    • ident_key - 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.
    3. to list
  3. - internal feature (not documented)
    logical PropertyHandle  :: SetKey ( NString &keynames, ::Key key_val )
    • keynames - Key name
    • key_val - Internal key value

      The key value structure corresponds to the structure of the passed or selected key.
    4. to list
to top previous next upper table of contents Comment