company logo

PropertyHandle :: InitPropertyHandle - Init property handle

The function initializes a property handle in a transient instance or in a transient instance field. The field must have been defined as property handle attribute (e.g. PI< Person > ), i.e. as generic type property handle field.

Passing an empty property handle will reinitialize the property handle.

The function returns a pointer to the initialized property handle or NULL, when initializing was not possible.

Notes:

Note, the transient property handles must be initialized and reinitialized explicitly. They are not reinitialized, when closing the instance.

Return value:  Pointer to property handle ( PropertyHandle * )

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

Implementation details

PropertyHandle * PropertyHandle  :: InitPropertyHandle ( NString &prop_path, PropertyHandle *property_handle )
  • prop_path - Property path

    A property path is passed as 0-terminated string. It may contain an extent or property name but also a sequence of property names separated by dot.

    Property path may start with a dot (.), which indicates, that the path starts in an upper property handle. One dot indicates, that the path starts in the current property handle. This distinction becomes necessary, when a property has the same name as an extent. To access the property in this case, one dot must precede the property name. The first dot can be omitted, when the property name is not an extent name.

    Referring to a path starting in a parent property handle requires two dots (..), the parents parent three and so on.

    address.street

    .address.street

  • property_handle - Pointer to property handle

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