company logo

PropertyHandle :: AddObject - Add object by object identity

The function provides a fast way for building an object collection. The function only adds the instances to the collection index without checking the instance data type. The application is responsible to pass object identities for proper instances. Otherwise, reading instances from the collection later might result in a type conflict. In order to avoid type conflicts, the collection might be defined as VOID collection .

Maximum one index (sort order) can be defined for the collection. In this case, a key value must be passed. For unordered indexes, new instances will be appended at the end of the collection.

The function can be used for adding instances to collections, only, which are not instance owner and which do not have inverse relationship or base collections.

Return value:  Success ( logical  )

Implementation details

logical PropertyHandle  :: AddObject ( int64 objid, ::Key sort_key )
  • objid - - internal feature (not documented)
  • sort_key - - internal feature (not documented)