table of contents
other versions
- wheezy 0.7.3-6
- jessie 0.7.3-6+b2
- testing 0.9.4-1
- unstable 0.9.4-1
- experimental 0.10.0-1
gd_alter_encoding(3) | GETDATA | gd_alter_encoding(3) |
NAME¶
gd_alter_encoding — modify the binary encoding of data in a dirfileSYNOPSIS¶
#include <getdata.h>int
gd_alter_encoding(DIRFILE *dirfile, unsigned int
encoding, int fragment_index, int
recode);
DESCRIPTION¶
The gd_alter_encoding() function sets the binary encoding of the format specification fragment given by fragment_index to byte_sex in the dirfile(5) database specified by dirfile. 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 binary encoding of a fragment containing no RAW fields is ignored.- GD_UNENCODED, GD_BZIP2_ENCODED, GD_GZIP_ENCODED, GD_LZMA_ENCODED, GD_SLIM_ENCODED, GD_TEXT_ENCODED.
RETURN VALUE¶
Upon successful completion, gd_alter_encoding() returns zero. On error, it returns -1 and sets the dirfile error 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_DIRFILE
- The supplied dirfile was invalid.
- GD_E_BAD_INDEX
- The supplied index was out of range.
- GD_E_PROTECTED
- The metadata of the given format specification fragment was protected from change, or the binary data of the fragment was protected from change and binary file recoding was requested.
- GD_E_RAW_IO
- An I/O error occurred while attempting to recode a binary file.
- GD_E_UNCLEAN_DB
- An error occurred while moving the recoded file into place. As a result, the database may be in an unclean state. See the NOTES section below for recovery instructions. In this case, the dirfile will be flagged as invalid, to prevent further database corruption. It should be immediately closed.
- GD_E_UNKNOWN_ENCODING
- The encoding scheme of the fragment is unknown.
- GD_E_UNSUPPORTED
- The encoding scheme of the fragment does not support binary file recoding.
NOTES¶
A binary file recoding occurs out-of-place. As a result, sufficient space must be present on the filesystem for the binary files of all RAW fields in the fragment both before and after translation. If all fragments are updated by specifying GD_ALL_FRAGMENTS, the recoding occurs one fragment at a time.SEE ALSO¶
gd_cbopen(3), gd_error(3), gd_error_string(3), gd_encoding(3), dirfile(5), dirfile-format(5)20 July 2010 | Version 0.7.0 |