Section 3: library functions
NAME get_nmfields — report the number of metafields in a dirfile SYNOPSIS #include <getdata.h> unsigned int get_nmfields(DIRFILE *dirfile, const char *parent); DESCRIPTION The get_nmfields() function queries a dirfile(5) database specified by dirfile and returns the number of metafields defined in the database for the parent field specified by parent. The dirfile argument must point to…
NAME get_nframes64 — report the size of a dirfile with largefile support SYNOPSIS #define _LARGEFILE64_SOURCE #include <getdata.h> off64_t get_nframes64(DIRFILE *dirfile); DESCRIPTION This version of get_nframes(3) uses a 64-bit offset type, even if off_t is a 32-bit type. It is only available if one defines _LARGEFILE64_SOURCE. If off_t is a 64-bit type (i.e. if _FILE_OFFSET_BITS is…
NAME get_nframes — report the size of a dirfile SYNOPSIS #include <getdata.h> off_t get_nframes(DIRFILE *dirfile); DESCRIPTION The get_nframes() function queries a dirfile(5) database specified by dirfile and returns the number of frames in the database. Since different fields may have differing number of frames, the Dirfile Standards (see dirfile(5)) dictate that the number of frames…
NAME get_nfragments — retrieve the number of format file fragments in a dirfile SYNOPSIS #include <getdata.h> int get_nfragments(const DIRFILE *dirfile); DESCRIPTION The get_nfragments() function queries a dirfile(5) database specified by dirfile and returns the total number of parsed format file fragments in the database. The dirfile argument must point to a valid DIRFILE object previously…
NAME get_nfields_by_type — report the number of fields of a given type in a dirfile SYNOPSIS #include <getdata.h> unsigned int get_nfields_by_type(DIRFILE *dirfile, gd_entype_t type); DESCRIPTION The get_nfields_by_type() function queries a dirfile(5) database specified by dirfile and returns the number of fields of type type defined in the database. Notably, this count does not include /META…
NAME get_nfields — report the number of fields in a dirfile SYNOPSIS #include <getdata.h> unsigned int get_nfields(DIRFILE *dirfile); DESCRIPTION The get_nfields() function queries a dirfile(5) database specified by dirfile and returns the number of fields defined in the database. Notably, this count does not include /META fields. The dirfile argument must point to a valid…
NAME get_native_type — returns the native data type of a field in a dirfile SYNOPSIS #include <getdata.h> gd_type_t get_native_type(DIRFILE *dirfile, const char *field_code); DESCRIPTION The get_native_type() function queries a dirfile(5) database specified by dirfile and returns the native data type of the field field_code, which may contain a representation suffix. The dirfile argument must point…
NAME rpc – library routines for remote procedure calls SYNOPSIS AND DESCRIPTION These routines allow C programs to make procedure calls on other machines across the network. First, the client calls a procedure to send a data packet to the server. Upon receipt of the packet, the server calls a dispatch routine to perform the…
NAME get_mvector_list — retrieve a list of vector fields in a dirfile SYNOPSIS #include <getdata.h> const char **get_mvector_list(DIRFILE *dirfile, const char *parent); DESCRIPTION The get_mvector_list() function queries a dirfile(5) database specified by dirfile and returns a read-only list of names of the all vector type metafields for the specified parent field defined in the database…
NAME get_mstrings — retrieve a list of string values from a dirfile SYNOPSIS #include <getdata.h> const char **get_mstrings(DIRFILE *dirfile, const char *parent); DESCRIPTION The get_mstrings() function queries a dirfile(5) database specified by dirfile and returns a read-only list of values of the all STRING type metafields for the supplied parent field. The dirfile argument must…
NAME get_mouse_mickeys – How far the mouse has moved since the last call to this function. Allegro game programming library. SYNOPSIS #include <allegro.h> void get_mouse_mickeys(int *mickeyx, int *mickeyy); DESCRIPTION Measures how far the mouse has moved since the last call to this function. The values of mickeyx and mickeyy will become negative if the mouse…
NAME add_mibdir, netsnmp_init_mib, shutdown_mib, netsnmp_read_module, read_mib, read_all_mibs, add_module_replacement, snmp_set_mib_errors, snmp_set_mib_warnings, snmp_set_save_descriptions, read_objid, snmp_parse_oid, get_module_node, print_mib, print_objid, fprint_objid, snprint_objid, print_description, fprint_description, snprint_description – netsnmp_mib_api functions SYNOPSIS #include <net-snmp/mib_api.h> Initialisation and Shutdown int add_mibdir(const char *dirname); void netsnmp_init_mib(void); void shutdown_mib(void); Reading and Parsing MIBs struct tree *netsnmp_read_module(const char *name); struct tree *read_mib(const char *filename); struct tree *read_all_mibs(void);…
NAME get_midi_length – Determines the total playing time of a midi, in seconds. Allegro game programming library. SYNOPSIS #include <allegro.h> int get_midi_length(MIDI *midi); DESCRIPTION This function will simulate playing the given MIDI, from start to end, to determine how long it takes to play. After calling this function, midi_pos will contain the negative number of…
NAME get_mfield_list_by_type — retrieve a list of fields in a dirfile SYNOPSIS #include <getdata.h> const char **get_mfield_list_by_type(DIRFILE *dirfile, const char *parent, gd_entype_t type); DESCRIPTION The get_mfield_list_by_type() function queries a dirfile(5) database specified by dirfile and returns a read-only list of names of the all metafields of the indicated type for the supplied parent field. The…
NAME get_mfield_list — retrieve a list of fields in a dirfile SYNOPSIS #include <getdata.h> const char **get_mfield_list(DIRFILE *dirfile, const char *parent); DESCRIPTION The get_mfield_list() function queries a dirfile(5) database specified by dirfile and returns a read-only list of names of the all metafields for the specified parent field in the database. The dirfile argument must…
NAME get_mconstants — retrieve a list of constant values from a dirfile SYNOPSIS #include <getdata.h> const void *get_mconstants(DIRFILE *dirfile, gd_type_t return_type, const char *parent); DESCRIPTION The get_mconstants() function queries a dirfile(5) database specified by dirfile and returns a read-only list of values of the all CONST type metafields for the supplied parent field after type…
NAME get_hardware_volume – Retrieves the hardware sound output volume. Allegro game programming library. SYNOPSIS #include <allegro.h> void get_hardware_volume(int *digi_volume, int *midi_volume); DESCRIPTION Retrieves the hardware sound output volume, both for digital samples and MIDI playback, as integers from 0 to 255, or -1 if the information is not available. Parameters digi_volume and midi_volume must be…
NAME get_gfx_mode_list – Obtains a list of available video modes. Allegro game programming library. SYNOPSIS #include <allegro.h> GFX_MODE_LIST *get_gfx_mode_list(int card); DESCRIPTION Attempts to create a list of all the supported video modes for a certain graphics driver, made up from the GFX_MODE_LIST structure, which has the following definition: typedef struct GFX_MODE_LIST { int num_modes; GFX_MODE…
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 get_frameoffset — report the starting frame of fields in a dirfile SYNOPSIS #include <getdata.h> off_t get_frameoffset(DIRFILE *dirfile, int fragment_index); DESCRIPTION The get_frameoffset() function queries a dirfile(5) database specified by dirfile and returns the frame offset (see dirfile-format(5)) for the fragment indexed by fragment_index. The frame offset of a fragment indicate the frame number of…