plucky (3) gd_parent_fragment.3.gz

NAME

       gd_parent_fragment — retrieve the parent fragment of a fragment in a Dirfile

SYNOPSIS

       #include <getdata.h>

       int gd_parent_fragment(DIRFILE *dirfile, int fragment_index);

DESCRIPTION

       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:

       GD_E_BAD_DIRFILE
               The supplied dirfile was invalid.

       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).

HISTORY

       The get_parent_fragment() function appeared in GetData-0.5.0.

       In GetData-0.7.0, this function was renamed to gd_parent_fragment().

       In GetData-0.10.0, the error return from this function changed from -1 to a negative-valued error code.

SEE ALSO

       dirfile(5), gd_include(3), gd_open(3), gd_fragmentname(3), gd_nfragments(3)