company logo

Property :: use - Use passed property handle

The function creates a copy of the property handle passed in cProperty. Both, the copy and the origin, share the cursor, access key selection, filter settings and event handlers, i.e. changing the instance selection in one of the property handles will automatically change the instance selection in the other.

When the property is referring to a transient reference, the property handle referenced by the transient reference will be set to the passed property and it will be checked, whether the type definition for the transient reference fits to the data type of the property handle passed, i.e. the opened property handle's data type must inherit from the data type of the transient reference. In order to assign another access node (cursor) directly to the property handle, it has to be closed before. In C++ programming, one may also use the operator=.

When the passed property is referring to a transient reference, the referenced property handle will be used.

In order to create a property referring to a separate cursor one may call cursorCopy().

When the property handle passed is not valid, the calling property is closed. No exception is thrown, even if the property after calling use() is not valid.

Return value:  Property reference ( odaba::Property & )

A property handle refers to a (usually) opened property. Invalid properties may cause an exception.

Implementation details

odaba::Property & Property  :: use ( odaba::Property &cProperty )
  • cProperty - Property reference

    A property handle refers to a (usually) opened property. Invalid properties may cause an exception.