gd_parent_fragment3
Retrieve the parent fragment of a fragment in a dirfile
Usage
#include <getdata.h>
int gd_parent_fragment(DIRFILE *dirfile, int fragment_index);
Overview
The gd_parent_fragment() function queries a dirfile(5) database specified by dirfile and returns the index of the fragment which contains the INCLUDE directive for the fragment indexed by fragment_index.
Since the primary format specification fragment is not included in any other fragment, passing zero for fragment_index will result in an error.
Return value
On success, gd_parent_fragment() returns the index of the specified fragment's parent. On error, gd_parent_fragment() returns a negative-valued error code. Possible error codes are:
.TP 8 GD_E_BAD_DIRFILE The supplied dirfile was invalid.
.TP 8 GD_E_BAD_INDEX The supplied index was out of range, or was equal to zero.
The error code is also stored in the DIRFILE object and may be retrieved after this function returns by calling gd_error(3). A descriptive error string for the error may be obtained by calling gd_error_string(3).
Releases
7 releases since Debian 7 (Wheezy); the text changed 2 times.