Section 3: library functions
NAME dirfile_free_entry_strings — free strings in a GetData gd_entry_t object SYNOPSIS #include <getdata.h> gd_entry_t *dirfile_free_entry_strings(gd_entry_t *entry); DESCRIPTION The dirfile_free_entry_strings() function frees the character strings found in the gd_entry_t object entry which were previously allocated by a call to get_entry(3). If entry is NULL, this function does nothing. If non-NULL, entry must point to a valid…
NAME dirfile_flush — write all pending dirfile changes to disk. SYNOPSIS #include <getdata.h> int dirfile_flush(DIRFILE *dirfile, const char *field_code); DESCRIPTION The dirfile_flush() function flushes and closes all file handles associated with field_code, or its input(s), in the dirfile specified by dirfile. If the field_code contains a valid representation suffix, it will be ignored. As a…
NAME dirfile_close, dirfile_discard — close a dirfile and free associated memory. SYNOPSIS #include <getdata.h> int dirfile_close(DIRFILE *dirfile); int dirfile_discard(DIRFILE *dirfile); DESCRIPTION The dirfile_close() function first calls dirfile_flush(3) to flush all metadata changes to disk and to close all file handles associated with dirfile. It then frees memory associated with the DIRFILE object. If dirfile is…
NAME dirfile_delete — remove a field from a dirfile SYNOPSIS #include <getdata.h> int dirfile_delete(DIRFILE *dirfile, const char *field_code, int flags); DESCRIPTION The dirfile_delete() function attempts to delete the field specified by field_code in the dirfile specified by dirfile. The field_code should not contain a representation suffix. The flags argument influences how the deletion attempt occurs….
NAME dirfile_close, dirfile_discard — close a dirfile and free associated memory. SYNOPSIS #include <getdata.h> int dirfile_close(DIRFILE *dirfile); int dirfile_discard(DIRFILE *dirfile); DESCRIPTION The dirfile_close() function first calls dirfile_flush(3) to flush all metadata changes to disk and to close all file handles associated with dirfile. It then frees memory associated with the DIRFILE object. If dirfile is…
NAME dirfile_cbopen, dirfile_open — open or create a dirfile SYNOPSIS #include <getdata.h> DIRFILE* dirfile_cbopen(const char *dirfilename, unsigned long flags, gd_parser_callback_t sehandler, void *extra); DIRFILE* dirfile_open(const char *dirfilename, unsigned long flags); DESCRIPTION The dirfile_cbopen() function opens or creates the dirfile specified by dirfilename, returning a DIRFILE object associated with it. Opening a dirfile will cause the…
NAME dirfile_alter_spec, dirfile_malter_spec — modify a field in a dirfile SYNOPSIS #include <getdata.h> int dirfile_alter_spec(DIRFILE *dirfile, const char *line, int recode); int dirfile_malter_spec(DIRFILE *dirfile, const char *line, const char *parent, int recode); DESCRIPTION The dirfile_alter_spec() function modifies the field described by the field specification line in line to the dirfile specified by dirfile. The dirfile_malter_spec()…
NAME dirfile_alter_bit, dirfile_alter_clincom, dirfile_alter_const, dirfile_alter_cpolynom, dirfile_alter_lincom, dirfile_alter_linterp, dirfile_alter_multiply, dirfile_alter_phase, dirfile_alter_polynom, dirfile_alter_raw, dirfile_alter_sbit — modify a field in a dirfile SYNOPSIS #include <getdata.h> int dirfile_alter_bit(DIRFILE *dirfile, const char *field_code, const char *in_field, gd_bit_t bitnum, gd_bit_t numbits); int dirfile_alter_clincom(DIRFILE *dirfile, const char *field_code, int n_fields, const char **in_fields, const double complex *cm, const double complex *cb); int…
NAME dirfile_alter_bit, dirfile_alter_clincom, dirfile_alter_const, dirfile_alter_cpolynom, dirfile_alter_lincom, dirfile_alter_linterp, dirfile_alter_multiply, dirfile_alter_phase, dirfile_alter_polynom, dirfile_alter_raw, dirfile_alter_sbit — modify a field in a dirfile SYNOPSIS #include <getdata.h> int dirfile_alter_bit(DIRFILE *dirfile, const char *field_code, const char *in_field, gd_bit_t bitnum, gd_bit_t numbits); int dirfile_alter_clincom(DIRFILE *dirfile, const char *field_code, int n_fields, const char **in_fields, const double complex *cm, const double complex *cb); int…
NAME dirfile_alter_bit, dirfile_alter_clincom, dirfile_alter_const, dirfile_alter_cpolynom, dirfile_alter_lincom, dirfile_alter_linterp, dirfile_alter_multiply, dirfile_alter_phase, dirfile_alter_polynom, dirfile_alter_raw, dirfile_alter_sbit — modify a field in a dirfile SYNOPSIS #include <getdata.h> int dirfile_alter_bit(DIRFILE *dirfile, const char *field_code, const char *in_field, gd_bit_t bitnum, gd_bit_t numbits); int dirfile_alter_clincom(DIRFILE *dirfile, const char *field_code, int n_fields, const char **in_fields, const double complex *cm, const double complex *cb); int…
NAME dirfile_alter_bit, dirfile_alter_clincom, dirfile_alter_const, dirfile_alter_cpolynom, dirfile_alter_lincom, dirfile_alter_linterp, dirfile_alter_multiply, dirfile_alter_phase, dirfile_alter_polynom, dirfile_alter_raw, dirfile_alter_sbit — modify a field in a dirfile SYNOPSIS #include <getdata.h> int dirfile_alter_bit(DIRFILE *dirfile, const char *field_code, const char *in_field, gd_bit_t bitnum, gd_bit_t numbits); int dirfile_alter_clincom(DIRFILE *dirfile, const char *field_code, int n_fields, const char **in_fields, const double complex *cm, const double complex *cb); int…
NAME dirfile_alter_bit, dirfile_alter_clincom, dirfile_alter_const, dirfile_alter_cpolynom, dirfile_alter_lincom, dirfile_alter_linterp, dirfile_alter_multiply, dirfile_alter_phase, dirfile_alter_polynom, dirfile_alter_raw, dirfile_alter_sbit — modify a field in a dirfile SYNOPSIS #include <getdata.h> int dirfile_alter_bit(DIRFILE *dirfile, const char *field_code, const char *in_field, gd_bit_t bitnum, gd_bit_t numbits); int dirfile_alter_clincom(DIRFILE *dirfile, const char *field_code, int n_fields, const char **in_fields, const double complex *cm, const double complex *cb); int…
NAME dirfile_alter_bit, dirfile_alter_clincom, dirfile_alter_const, dirfile_alter_cpolynom, dirfile_alter_lincom, dirfile_alter_linterp, dirfile_alter_multiply, dirfile_alter_phase, dirfile_alter_polynom, dirfile_alter_raw, dirfile_alter_sbit — modify a field in a dirfile SYNOPSIS #include <getdata.h> int dirfile_alter_bit(DIRFILE *dirfile, const char *field_code, const char *in_field, gd_bit_t bitnum, gd_bit_t numbits); int dirfile_alter_clincom(DIRFILE *dirfile, const char *field_code, int n_fields, const char **in_fields, const double complex *cm, const double complex *cb); int…
NAME get_frameoffset64, dirfile_alter_frameoffset64 — report or change the frame offset of fields in a dirfile, with largefile support SYNOPSIS #define _LARGEFILE64_SOURCE #include <getdata.h> off64_t get_frameoffset(DIRFILE *dirfile, int fragment_index); int dirfile_alter_frameoffset64(DIRFILE *dirfile, off64_t offset, int fragment_index, int move); DESCRIPTION These version of get_frameoffset(3) and dirfile_alter_frameoffset(3) use a 64-bit offset type, even if off_t is a 32-bit…
NAME dirfile_alter_entry — modify the metadata of a dirfile field SYNOPSIS #include <getdata.h> int dirfile_alter_entry(DIRFILE *dirfile, const char *field_code, const gd_entry_t *entry, int recode); DESCRIPTION The dirfile_alter_entry() function modifies the field specified by field_code in the dirfile specified by dirfile to correspond to the new parameters specified by entry. In addition to specifying a regular…
NAME dirfile_alter_bit, dirfile_alter_clincom, dirfile_alter_const, dirfile_alter_cpolynom, dirfile_alter_lincom, dirfile_alter_linterp, dirfile_alter_multiply, dirfile_alter_phase, dirfile_alter_polynom, dirfile_alter_raw, dirfile_alter_sbit — modify a field in a dirfile SYNOPSIS #include <getdata.h> int dirfile_alter_bit(DIRFILE *dirfile, const char *field_code, const char *in_field, gd_bit_t bitnum, gd_bit_t numbits); int dirfile_alter_clincom(DIRFILE *dirfile, const char *field_code, int n_fields, const char **in_fields, const double complex *cm, const double complex *cb); int…
NAME dirfile_alter_bit, dirfile_alter_clincom, dirfile_alter_const, dirfile_alter_cpolynom, dirfile_alter_lincom, dirfile_alter_linterp, dirfile_alter_multiply, dirfile_alter_phase, dirfile_alter_polynom, dirfile_alter_raw, dirfile_alter_sbit — modify a field in a dirfile SYNOPSIS #include <getdata.h> int dirfile_alter_bit(DIRFILE *dirfile, const char *field_code, const char *in_field, gd_bit_t bitnum, gd_bit_t numbits); int dirfile_alter_clincom(DIRFILE *dirfile, const char *field_code, int n_fields, const char **in_fields, const double complex *cm, const double complex *cb); int…
NAME dirfile_alter_bit, dirfile_alter_clincom, dirfile_alter_const, dirfile_alter_cpolynom, dirfile_alter_lincom, dirfile_alter_linterp, dirfile_alter_multiply, dirfile_alter_phase, dirfile_alter_polynom, dirfile_alter_raw, dirfile_alter_sbit — modify a field in a dirfile SYNOPSIS #include <getdata.h> int dirfile_alter_bit(DIRFILE *dirfile, const char *field_code, const char *in_field, gd_bit_t bitnum, gd_bit_t numbits); int dirfile_alter_clincom(DIRFILE *dirfile, const char *field_code, int n_fields, const char **in_fields, const double complex *cm, const double complex *cb); int…
NAME dirfile_alter_bit, dirfile_alter_clincom, dirfile_alter_const, dirfile_alter_cpolynom, dirfile_alter_lincom, dirfile_alter_linterp, dirfile_alter_multiply, dirfile_alter_phase, dirfile_alter_polynom, dirfile_alter_raw, dirfile_alter_sbit — modify a field in a dirfile SYNOPSIS #include <getdata.h> int dirfile_alter_bit(DIRFILE *dirfile, const char *field_code, const char *in_field, gd_bit_t bitnum, gd_bit_t numbits); int dirfile_alter_clincom(DIRFILE *dirfile, const char *field_code, int n_fields, const char **in_fields, const double complex *cm, const double complex *cb); int…
NAME dirfile_add_bit, dirfile_add_clincom, dirfile_add_const, dirfile_add_cpolynom, dirfile_add_lincom, dirfile_add_linterp, dirfile_add_multiply, dirfile_add_phase, dirfile_add_polynom, dirfile_add_raw, dirfile_add_sbit, dirfile_add_string — add a field to a dirfile SYNOPSIS #include <getdata.h> int dirfile_add_bit(DIRFILE *dirfile, const char *field_name, const char *in_field, gd_bit_t bitnum, gd_bit_t numbits, int fragment_index); int dirfile_add_clincom(DIRFILE *dirfile, const char *field_name, int n_fields, const char **in_fields, const double complex *cm, const double…