company logo

PropertyHandle :: SetTransientProperty - Setting property handle for transient property (reference)

This function sets the current handle for a transient property handle. The function will not create a copy of the property handle. The associated handle is registered, only.

When a copy of the referenced property handle is required the application has to create the copy before setting it. After associating the copy for the referenced property handle it can be destroyed. Because it is registered in the transient property handle it will be destroyed when resetting the transient reference or when setting another property handle for the same transient reference.

When creating a copy of a transient reference the copy will get the same referenced handle. All referenced property handles for the original transient property handle and all its copies will be updated when setting a new property handle for the original transient property handle or one of its copies.

Transient property handles are destroyed automatically when they are placed in a persistent object instance and this instance is destroyed. When, however, referring recursively to a property handle by associating a parent or higher property handle with a subordinated property handle this may result in never deleting the access node. Use MarkUsed() and MarkUnused() for handling this situation.

You can release the associated property handle using the ResetTransientProperty() function.

Return value:  Success ( logical  )

Implementation details

logical PropertyHandle  :: SetTransientProperty ( PropertyHandle &prop_hdl )
  • prop_hdl - Property Handle

    Is a reference to an (usually) opened property handle.