Each function is described under a separate heading, with the following information given about each function;Function A brief description of the function.
Syntax A function prototype. The following symbols are used to specify the expected types of the various arguments and results.
[ ... ] One or more of the preceding type is expected. { ... } An array is expected. IS_NULL A null result or nothing is expected. IS_INTEGER An integer is expected. IS_FLOAT A floating point number is expected. IS_STRING A string is expected. IS_FILE An file stream is expected. IS_FUNCTION A function reference is expected. IS_POINTER A variable pointer is expected. IS_ISAM An ISAM file descriptor is expected. IS_ANY Any data type might be expected. Remarks A verbose description of the function, possibly including brief examples of its usage. Item which appear in italics will be references to symbols shown within the syntax prototype.
Returns An explanation of the expect results of calling the function, for both a successful and unsuccessful invokation. These may include reference to the constants EOF and NULL which will often be used as a error return value.
See also Cross-references to other related functions. A reference to another function within this libarary will be shown followed by open/closed braces, for example, fopen() is a reference to fopen within this libarary. But other refernces may include a number within the braces, for example fopen(3). These indicate that reference should be made to the standard Unix reference manuals, and the number indicates the standard section in which the reference would be found.
The standard library functions are created to closely resemble many commonly available C and Posix library functions. In many cases these directly relate to an equivalent C library function, and this will be noted under "See Also" by a reference to a standard Unix manual section 2 or section 3 entry.
atoi Convert a string into it decimal representation bsearch Search a sorted array chdir Change working directory date Generate a string representation of a date value. define Assign a value to a glossary variable. eval Evaluate a string as an expression fclose Close an opened file stream. feof Test for an end-of-file condition. fflush Write all buffered data from a file stream. fgetc Read a character from a file stream. fgets Read a string from a file stream. fopen Open a file stream for reading or writing. format Create a formatted string. fputc Write a character to a file stream. fputs Write a string to a file stream. free Free allocated dynamic memory. fseek Reposition a file stream. ftell Get the position of a file stream. getcwd Get current working directory getenv Return the value of an environment variable. gets Read a string from a file stream. glos_close Close a glossary file. glos_find Find a section in all opened glossary files. glos_open Open a glossary file. glos_read Read a glossary file. include Evalute the contents of a file. index Find a substring within a string. io Copy an entire file stream. loadfileimage Read an entire file into dynamic memory. malloc Allocates dynamic memory. msg_close Close a message catalogue. msg_get Read message from a message catalogue. msg_open Open a message catalogue. parse Parse a string. putenv Change or add an environment variable. qsort Sort an array rand Random number generator. read Read a variable from a file stream. rewind Reposition to the start of a file stream. sizeof Obtain the size of an element. srand Random number generator. strcmp_wild Find a wild card within a string. strlen Calculate the length of a string. strlower Convert a string to upper and lower case. strstr_case Search for a substring within a string. substr Extract part of a string. system Execute a shell command. time Return system time in seconds. tmpfile Create a temporary file tolower Convert a string to lower case. toupper Convert a string to upper case. trim Strip leading and trailing space. unlink Unlink (remove) a file. write Write a list of variables into a file.
The Unix library functions are created to closely resemble many commonly available C and Posix library functions which are specific to the Unix platform. These functions are not available in the Windows 32bit platform (e.g. Print Control for Windows). In many cases these directly relate to an equivalent C library function, and this will be noted under "See Also" by a reference to a standard Unix manual section 2 or section 3 entry.
alarm Set an interval timer dclose Close a character special device file. dopen Open a character special device file. exit Force termination and exit from the program. fork Create a new process. getpid Get ID of the calling process. glos_exec Execute a shell script held in a glossary file. kill Send a signal to a process or process group. link Make a new name for a file nice Change priority of the calling process. pclose Close an interprocess pipe stream. popen Open an interprocess pipe stream. sleep Suspend execution for an interval. termio Set terminal interface settings.
The following functions are provided to be used when creating reports in UxFax2. These are ISAM file functions. Most of these closely resemble common C-ISAM library functions.
glosdump Dump a glossary entry to a file. isclose Close an ISAM file. isdelcurr Delete the current record. isdelete Delete a specific record. isfield Identify a field by name. isopen Open an ISAM data file. ispop Restore prior file postion ispush Save the current file postion isread Read a record from an ISAM data file. isrewcurr Rewrite the current record. isrewrite Rewrite a specific record. issetunique Set a unique identifier. isstart Select and index and locate a record. isuniqueid Return a unique identifier iswrite Write a new record.