company logo

Property :: locatePosition - Locate instance by position

The function might be called on order to set an offset for the next iteration function call (next()) or read operation (get()).

The function locates an instance in the collection at position passed in iPosition. The function does not check filter conditions. 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.

The function returns true, when an instance has been located successfully and false otherwise. After terminating successfully, an instance is located in the property handle.

Return value:  Success ( bool  )

The value is true when the function was executed successfully. Otherwise the value is set to false.

Implementation details

bool Property  :: locatePosition ( int32 iPosition )
  • iPosition - Position in collection

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