company logo

DBObjectHandle :: GetExtent - Provide extent form Database Object

The function returns the name of the n-th extent in the list of extents that are allocated for the database object. The collection of allocated extents does not necessarily include all defined extents. Extent names are provided in alphabetic order. The first extent has the index 0.

After providing the last extent name the function returns NULL for the next extent name.

Return value:  Extent name ( NString & )

The name contains the name of the extent, only. It does not contain a namespace scope.

Notes:

retval checked for const &NString

Implementation details

const NString & DBObjectHandle  :: GetExtent ( int32 indx0 )
  • indx0 - Position in collection

    The position of an instance in a collection depends on the selected index. if the collection is unsorted the position is the only way for accessing the instance.

    For sorted collections the position is determined according to the instance key. If is a contradiction between position and key value the position will be ignored.

    Special positions are

    CUR_INSTANCE (-1) refers to the currently selected instance. If no instance is selected it refers to the first instance.

    FIRST_INSTANCE (0) refers to the first instance in a collection according to the selected index (sort order).

    FIRST_INSTANCE (0x7fffffff) refers to the last instance in a collection according to the selected index (sort order).