company logo

Property :: getRelative - Get relative instance

The function returns an instance according to the relative position in a collection, which is restricted by a filter, fixed key components or a context selection handler. The position passed to the collection refers to the iPosition-th available instance. Instances skipped because of conditions are not counted.

The value passed in iPosition must be a value greater or equal to 0. In case of an invalid position value, the function throws an exception.

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  :: getRelative ( int32 iPosition )
  • iPosition - Position in collection

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