get_endianness (3) - Linux Manuals

get_endianness: report the byte sex of fields in a dirfile

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

NAME

get_endianness --- report the byte sex of fields in a dirfile

SYNOPSIS

#include <getdata.h>

unsigned long get_endianness(DIRFILE *dirfile, int fragment_index);

DESCRIPTION

The get_endianness() function queries a dirfile(5) database specified by dirfile and returns the byte sex for the fragment indexed by fragment_index. The byte sex of a fragment indicate the endianness of data stored in binary files associated with RAW fields defined in the specified fragment. The endianness of a fragment containing no RAW fields is ignored.

The dirfile argument must point to a valid DIRFILE object previously created by a call to dirfile_open(3).

RETURN VALUE

Upon successful completion, get_endianness() returns the byte sex of the specified fragment, which will be either GD_BIG_ENDIAN or GD_LITTLE_ENDIAN. On error, it returns zero and sets the dirfile error to a non-zero error value. Possible error values are:

GD_E_BAD_DIRFILE: The supplied dirfile was invalid.
GD_E_BAD_INDEX: The supplied index was out of range. 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).