get_raw_filename (3) - Linux Manuals

get_raw_filename: retrieve the pathname of a binary file in a dirfile

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

NAME

get_raw_filename --- retrieve the pathname of a binary file in a dirfile

SYNOPSIS

#include <getdata.h>

const char *get_raw_filename(DIRFILE *dirfile, const char *field_code);

DESCRIPTION

The get_raw_filename() function retrieves the pathname of the file backing the RAW field specified by field_code in the dirfile specified by dirfile. If field_code contains a valid representation suffix, it will be ignored.

RETURN VALUE

On success, get_raw_filename() returns the full pathname of the binary file associated with the specified field. On error, NULL is returned and the dirfile error is set to a non-zero error value. Possible error values are:

GD_E_ALLOC: The library was unable to allocate memory.
GD_E_BAD_CODE: The field specified by field_code was not found.
GD_E_BAD_DIRFILE: The supplied dirfile was invalid.
GD_E_BAD_FIELD_TYPE: The field specified by field_code was not a RAW field.
GD_E_BAD_REPR: The representation suffix specified in field_code was not recognised.
GD_E_UNKNOWN_ENCODING: The encoding scheme of the specified field could not be determined or was not understood by GetData. 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).