table of contents
other versions
- wheezy 0.7.3-6
- jessie 0.7.3-6+b2
- testing 0.9.4-1
- unstable 0.9.4-1
- experimental 0.10.0-1
gd_uninclude(3) | GETDATA | gd_uninclude(3) |
NAME¶
gd_uninclude — remove a format specification fragment from a dirfileSYNOPSIS¶
#include <getdata.h>int
*gd_uninclude(DIRFILE *dirfile, int
fragment_index, int del);
DESCRIPTION¶
The gd_uninclude() removes the format specification fragment indexed by fragment_index from the specified dirfile, as well as any fragments the indicated fragment INCLUDEs. Fields defined in the removed fragments will be removed from the dirfile.RETURN VALUE¶
On success, gd_uninclude() returns zero. On error, -1 is returned and the dirfile error is set to a non-zero error value. Possible error values are:- GD_E_ACCMODE
- The supplied dirfile was opened in read-only mode.
- GD_E_ALLOC
- The library was unable to allocate memory.
- GD_E_BAD_DIRFILE
- The supplied dirfile was invalid.
- GD_E_BAD_INDEX
- The supplied fragment index was out of range, or an attempt was made to remove the primary format specification.
- GD_E_FLUSH
- A temporary file could not be opened into which to write the metadata of a modified, removed fragment, or renaming the temporary file over the original fragment failed.
- GD_E_PROTECTED
- The metadata of the fragment which included the removed fragment was protected from change.
- GD_E_RAW_IO
- An error occurred while trying to flush or close a removed field.
NOTES¶
This function re-arranges the remaining format specification fragments in some unspecified way, except for the primary fragment, which is guaranteed to remain at index zero. Callers which cache format specification fragment indices must re-initialise their cache after calling this function.SEE ALSO¶
gd_delete(3), gd_include(3), gd_open(3), gd_reference(3), gd_error(3), gd_error_string(3), gd_fragmentname(3), gd_nfragments(3), dirfile(5), dirfile-encoding(5), dirfile-format(5)15 October 2010 | Version 0.7.0 |