Rechercher une page de manuel
dirfile_add_raw
Langue: en
Version: 8 December 2008 (fedora - 04/07/09)
Section: 3 (Bibliothèques de fonctions)
NAME
dirfile_add_bit, dirfile_add_const, dirfile_add_lincom, dirfile_add_linterp, dirfile_add_multiply, dirfile_add_phase, dirfile_add_raw, dirfile_add_string --- add a field to a dirfileSYNOPSIS
#include <getdata.h>- int dirfile_add_bit(DIRFILE *dirfile, const char *field_name, const char *in_field, int bitnum, int numbits, int fragment_index);
- int dirfile_add_const(DIRFILE *dirfile, const char *field_name, gd_type_t const_type, gd_type_t data_type, void *value, int fragment_index);
- int dirfile_add_lincom(DIRFILE *dirfile, const char *field_name, int n_fields, const char **in_fields, const double *m, const double *b, int fragment_index);
- int dirfile_add_linterp(DIRFILE *dirfile, const char *field_name, const char *in_field, const char *table, int fragment_index);
- int dirfile_add_multiply(DIRFILE *dirfile, const char *field_name, const char *in_field1, const char *in_field2, int fragment_index);
- int dirfile_add_phase(DIRFILE *dirfile, const char *field_name, const char *in_field, int phase, int fragment_index);
- int dirfile_add_raw(DIRFILE *dirfile, const char *field_name, gd_type_t data_type, unsigned int spf, int fragment_index);
- int dirfile_add_string(DIRFILE *dirfile, const char *field_name, const char *value, int fragment_index);
DESCRIPTION
- These functions provide alternatives to using the dirfile_add(3) function to add a new field of the indicated type to the dirfile specified by dirfile.
In all of these calls, field_name indicates the name of the field to be added. Further, fragment_index is the index of the format file fragment into which the field should be added. (To convert a fragment index to its file name, see get_fragmentname(3).) The meaning and valid types of other arguments may be obtained from the get_entry(3) and dirfile-format(5) manual pages.
The dirfile_add_lincom() function takes pointers to three arrays of length n_fields containing the input field names (in_fields), the gain factors (m), and the offset terms (b).
The dirfile_add_string() and dirfile_add_const() functions both add the field and set the value of the field to value. For dirfile_add_const(), the const_type argument specifies the storage type for the const, while data_type specifies the data type of the value pointed to by value.
All fields added with this interface must contain numerical parameters. Fields with CONST fields as parameters cannot be added with these functions. Those fields must be added with dirfile_add_spec(3).
RETURN VALUE
On success, any of these functions returns zero. On error, -1 is returned and the dirfile error is set 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_CODE
- The field_name argument contained invalid characters.
- GD_E_BAD_DIRFILE
- The supplied dirfile was invalid.
- GD_E_BAD_ENTRY
- One or more of the field parameters specified was invalid.
- GD_E_BAD_INDEX
- The fragment_index argument was out of range.
- GD_E_BAD_TYPE
- The data_type or const_type argument provided to dirfile_add_raw() or dirfile_add_const(), was invalid.
- GD_E_DUPLICATE
- The field_name provided duplicated that of an already existing field.
- GD_E_PROTECTED
- The metadata of the fragment was protected from change. Or, the creation of a RAW field was attempted and the data of the fragment was protected.
- GD_E_RAW_IO
- An I/O error occurred while creating an empty binary file to be associated with a newly added RAW field.
- GD_E_UNKNOWN_ENCODING
- The encoding scheme of the specified format file fragment is not known to the library. As a result, the library was unable to create an empty binary file to be associated with a newly added RAW field.
- GD_E_UNSUPPORTED
- The encoding scheme of the specified format file fragment does not support creating an empty binary file to be associated with a newly added RAW field.
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_add(3), dirfile_add_spec(3), dirfile_madd_bit(3), dirfile_madd_const(3), dirfile_madd_lincom(3), dirfile_madd_linterp(3), dirfile_madd_multiply(3), dirfile_madd_phase(3), dirfile_madd_string(3), dirfile_metaflush(3), dirfile_open(3), get_error(3), get_error_string(3), dirfile-format(5)Contenus ©2006-2024 Benjamin Poulain
Design ©2006-2024 Maxime Vantorre