dirfile_add_spec (3) - Linux Manuals

dirfile_add_spec: add a field to a dirfile

Command to display dirfile_add_spec manual in Linux: $ man 3 dirfile_add_spec

NAME

dirfile_add_spec, dirfile_madd_spec --- add a field to a dirfile

SYNOPSIS

#include <getdata.h>

int dirfile_add_spec(DIRFILE *dirfile, const char *line, int fragment_index);
int dirfile_madd_spec(DIRFILE *dirfile, const char *line, const char *parent);

DESCRIPTION

The dirfile_add_spec() function adds the field described by the field specification line in line to the dirfile specified by dirfile. The dirfile_madd_spec() function behaves similarly, but adds the field as a metafield under the field indicated by the field parent. Field specification lines are described in detail in dirfile-format(5). Since Standards Version 7 (see dirfile(5)) permits specifying metafield without the use of the /META directive, dirfile_add_spec() may also be used to add metafields, by specifying the metafield's full field code. See dirfile-format(5) for full details.

When using dirfile_madd_spec(), line should only contain a field specification, and not a /META directive.

Passing these functions a directive line instead of a field specification line will result in a syntax error. These functions never call the registered parser callback function, even if line contains a syntax error.

RETURN VALUE

On success, dirfile_add_spec() and dirfile_madd_spec() return 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 specified dirfile was opened read-only.
GD_E_ALLOC: The library was unable to allocate memory.
GD_E_BAD_CODE: The parent field code was not found, or was already a metafield.
GD_E_BAD_DIRFILE: The supplied dirfile was invalid.
GD_E_BAD_INDEX: The fragment_index argument was out of range.
GD_E_FORMAT: A syntax error was encountered in line.
GD_E_PROTECTED: The metadata of the fragment was protected from change. Or, the creation of a RAW field was attempted and the data of the fragment was protected.
GD_E_RAW_IO: An I/O error occurred while creating an empty binary file to be associated with a newly added RAW field.
GD_E_UNKNOWN_ENCODING: The encoding scheme of the specified format file fragment is not known to the library. As a result, the library was unable to create an empty binary file to be associated with a newly added RAW field.
GD_E_UNSUPPORTED: The encoding scheme of the specified format file fragment does not support creating an empty binary file to be associated with a newly added RAW field. The dirfile error may be retrieved by calling get_error(3). A descriptive error string for the last error encountered can be obtained from a call to get_error_string(3).