company logo

Property :: extensionProperty - Get extension property handle

The function returns a property handle for a property extension, which has been stored in the instance currently selected. The function does not check, whether the extension property is an attribute or collection (reference or relationship), i.e. one may call this function for any type of property extension. When no instance is selected in the property handle, the function throws an exception.

Notes:

Property extensions just being created are accessible via this function only, when the instance or property extension has been saved ( save() ).

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

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

Implementation overview

Implementation details

  1. Get extension property handle by name
    odaba::Property & Property  :: extensionProperty ( odaba::String &sExtension )

    The function returns a property handle for the property extension , when a property extension with the property name passed in sExtension has been stored for the instance currently selected in the property handle. When no property extension has been found, the function throws an exception. In order to check, whether the requested property exists, extensionExist() might be called.

    When the property name has been overloaded in the database, the extension property as being defined in the database will be searched. Otherwise, property extensions defined in either the dictionary or the database are searched for.

    Notes:

    In order to get a property handle for any valid extension property (regardless whether it exists or not), one may simply call property() .

    • sExtension - Extension property name

      Extension property are defined in a database or resource database using 40 byte character names ( ASCII or Latin1). Extension names are passed as String .

    2. to list
  2. Get extension property handle by position
    odaba::Property & Property  :: extensionProperty ( int32 iPosition )

    The function returns a property handle for the property extension at position passed in iPosition . When no property extension has been stored at the position for the instance currently selected in the property handle, the function throws an exception. In order to check, whether the requested property exists, extensionCount() might be called.

    • iPosition - Position in collection

      The position of an element in a collection is beginning with 0 for the first element.

    3. to list
to top previous next upper table of contents Comment