DBStructDef :: GetRefPath - Get reference path

The function returns the reference/relationship path for the n-th ( indx0 ) reference or relationship.

Return value: Position in collection ( )

Position the entry is located at. If the entry could not be locates its contains the number of entries for the data structure.

int32 DBStructDef :: GetRefPath ( int32 indx0, logical full_path, NString &nstring, logical with_generics=NO, logical search_in_sharebase=YES )

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).
full_path - Full path
The full path option is used to request the property path including base structure names.
nstring - String object
with_generics - Include generic attributes Default: NO
search_in_sharebase - Provide attributes from base structures Default: YES