GD_ENCODING(3) - man page online | library functions

Report the binary encoding of data in a dirfile.

21 April 2012
gd_encoding(3)                               GETDATA                               gd_encoding(3)


gd_encoding — report the binary encoding of data in a dirfile


#include <getdata.h> unsigned long gd_encoding(DIRFILE *dirfile, int fragment_index);


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


Upon successful completion, gd_encoding() returns the binary encoding of the specified fragment, which will one of the following symbols: GD_UNENCODED, GD_BZIP2_ENCODED, GD_GZIP_ENCODED, GD_LZMA_ENCODED, GD_SIE_ENCODED, GD_SLIM_ENCODED, GD_TEXT_ENCODED, GD_ZZIP_ENCODED, GD_ZZSLIM_ENCODED, GD_ENC_UNSUPPORTED. If the encoding scheme specified in the dirfile metadata is unknown to GetData, GD_ENC_UN‐ SUPPORTED will be returned. See gd_cbopen(3) and dirfile-encoding(5) for the meanings of the other symbols and details on the supported encoding schemes. 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 gd_error(3). A descriptive error string for the last error encountered can be obtained from a call to gd_error_string(3).


gd_alter_encoding(3), gd_cbopen(3), gd_error(3), gd_error_string(3), gd_getdata(3), dirfile(5), dirfile-format(5)
Version 0.8.0 21 April 2012 gd_encoding(3)
This manual Reference Other manuals
gd_encoding(3) referred by gd_alter_encoding(3) | gd_encoding_support(3)
refer to dirfile(5) | dirfile-encoding(5) | dirfile-format(5) | gd_alter_encoding(3) | gd_cbopen(3) | gd_error(3) | gd_error_string(3) | gd_getdata(3)