dirfile_flush

Langue: en

Autres versions - même langue

Version: 28 November 2008 (fedora - 05/07/09)

Section: 3 (Bibliothèques de fonctions)

Sommaire

NAME

dirfile_flush --- close a dirfile and free associated memory.

SYNOPSIS

#include <getdata.h>
int dirfile_flush(DIRFILE *dirfile, const char *field_code);

DESCRIPTION

The dirfile_flush() function flushes and closes all file handles associated with field_code, or its input(s), in the dirfile specified by dirfile. As a special case, if field_code is NULL, all fields in dirfile will be flushed and closed. In this special case, modified metadata will also be flushed to disk as if dirfile_metaflush(3) has been called.

RETURN VALUE

On success, zero is returned. On error, -1 is returned and the dirfile error is set to a non-zero error value. Possible error values are:
GD_E_BAD_CODE
The field specified by field_code was not found in the database.
GD_E_BAD_DIRFILE
The supplied dirfile was invalid.
GD_E_RAW_IO
An error occurred while trying to flush or close the field(s).

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

SEE ALSO

dirfile_open(3), dirfile_close(3), dirfile_metaflush(3), get_error(3), get_error_string(3)