Native TUXEDO FML Functions

The following Silk Performer functions are identical to the TUXEDO FML functions of the same name without the Tux_ prefix.

Include file

FML.bdh

Function Description
Tux_GetFerror Produces a message on the standard error output, describing the last error encountered during a call to a system or library function.
Tux_Fldid Provides a run-time translation of a field-name to its field identifier and returns a field identifier corresponding to its field name parameter.
Tux_Fname Provides a run-time translation of a field identifier to its field name and returns a pointer to a character string containing the name corresponding to its argument.
Tux_Ftype Returns a pointer to a string containing the name of the type of a field.
Tux_Fldtype Returns the field type contained in a field identifier.
Tux_Fldno Returns the field number contained in a field identifier.
Tux_Flen Finds the value of a specified field occurrence in a buffer and returns its length.
Tux_Fielded Tests whether a specified buffer is fielded.
Tux_Fneeded Determines the space that must be allocated for a number of fields and bytes of value space.
Tux_Finit Initializes a fielded buffer statically.
Tux_Falloc Dynamically allocates space for a fielded buffer and calls the Tux_Finitfunction to initialize it.
Tux_Ffree Recovers space allocated to a fielded buffer.
Tux_Fsizeof Returns the size of a fielded buffer in bytes.
Tux_Fused Returns the amount of used space in a fielded buffer in bytes, including both user data and the header.
Tux_Funused Returns the amount of space currently unused in a buffer. Space is unused if it contains neither user data nor overhead data such as the header and index.
Tux_Frealloc Re-allocates space to enlarge a fielded buffer.
Tux_Fmove Copies data from a fielded buffer to any type of buffer.
Tux_Fcpy Copies the contents of one fielded buffer to another fielded buffer.
Tux_Fadd Adds a specified field value to the given buffer.
Tux_Fadds Handles the case of conversion from a user string field type to a specified field type and add it to the fielded buffer.
Tux_Fappend Adds a specified field value to the end of the given buffer.
Tux_Fchg Changes the value of a field in a buffer.
Tux_Fchgs Handles the case of conversion from a user string field type.
Tux_Fcmp Compares the field identifiers and then the field values of two FML buffers.
Tux_Fdelall Deletes all occurrences of the specified field in the buffer.
Tux_Fdelete Deletes all occurrences of all fields listed in an array of field identifiers.
Tux_Fdel Deletes a specified field occurrence from a buffer.
Tux_Ffindlast Finds the last occurrence of a field in a buffer.
Tux_Ffind Finds the value of a specified field occurrence in a buffer.
Tux_Ffindocc Looks at occurrences of a specified field in a buffer and returns the occurrence number of the first field occurrence that matches the user specified field value.
Tux_Fget Retrieves a field from a fielded buffer when the value is to be modified.
Tux_Fgets Retrieves a field occurrence from the fielded buffer first converting the value to a user string field type.
Tux_Fgetsa Gets a specified field from a buffer, allocates space, converts the field to the type specified by the user and returns a pointer to its location.
Tux_Fgetalloc Acquires space for a field, then finds and makes a copy of a buffer field.
Tux_Fgetlast Retrieves both the value and occurrence number of the last occurrence of a field.
Tux_Fnext Finds the next field in a buffer after a specified field occurrence.
Tux_Fnum Returns the number of fields contained in a specified buffer.
Tux_Foccur Determines the number of occurrences of a field.
Tux_Fpres Detects if a given occurrence of a specified field exists in a buffer.
Tux_Fvall Works like the Tux_Ffind function for long and short values, but returns the actual value of the field as a long rather than a pointer to the value.
Tux_Fvals Works like the Tux_Ffind function for string values but guarantees that a value is returned.
Tux_Fconcat Adds fields from a source buffer to the fields that already exist in a destination buffer.
Tux_Fjoin Joins two fielded buffers based on matching field id/occurrence.
Tux_Fojoin Works like the Tux_Fjoin function, but it keeps fields from the destination buffer that have no corresponding field id/occurrence in the source buffer.
Tux_Fproj Updates a buffer so as to keep only the desired fields.
Tux_Fprojcpy Works like the Tux_Fproj function, but the projection is done into a destination buffer instead of in-place.
Tux_Fupdate Updates a destination buffer with the field values in a source buffer.
Tux_Fvftos Transfers data from a fielded buffer to a common data structure.
Tux_Fvstof Transfers data from a common data structure to a fielded buffer.
Tux_Fvsinit Initializes all members in a common data structure to the NULL values specified in a view description.
Tux_Fvopt Allows users to specify buffer-to-structure mapping options at run time.
Tux_Fvnull Determines if an occurrence of a structure element is null.
Tux_Fvselinit Initializes an individual element of a common data structure to its appropriate NULL value.
Tux_Fvrefresh Clears and re-initializes the internal cache of view structure mappings.
Tux_CFadd Acts like the Tux_Fadd function, but first converts the value from the user-specified type to the type for which a field is added to the fielded buffer.
Tux_CFchg Acts like the Tux_Fchg function, but first converts the value from the user-specified type to the type for which the field is changed in the fielded buffer.
Tux_CFfind Finds a specified field in a buffer, converts it and returns a pointer to the converted value.
Tux_CFindocc Acts like the Tux_Ffindocc function, but first converts the value from the user-specified type to a specified type.
Tux_CFget Works like the Tux_Fget function. The main difference is that it copies a converted value to a user supplied buffer.
Tux_CFgetalloc Gets a specified field from a buffer, allocates space, converts the field to the type specified by the user and returns a pointer to its location.
Tux_Ftypcvt Converts a value from one field type to another.
Tux_Fstrerror Retrieves the text of an error message.
Tux_Fidxused Indicates the current amount of space used by a buffer's index.
Tux_Funindex Discards a fielded buffer's index.
Tux_Findex Serves to index a fielded buffer.
Tux_Frstrindex Serves to re-index an unindexed buffer.
Tux_Fboolev Checks whether a fielded buffer matches a number of specified conditions.
Tux_Fvboolev Checks whether a fielded buffer matches a number of specified conditions.
Tux_Ffloatev Returns the value of a specified arithmetic expression, represented by a tree.
Tux_Fboolco Compiles a Boolean expression and returns a pointer to the evaluation tree.
Tux_Fvboolco Compiles a Boolean expression and returns a pointer to the evaluation tree.
Tux_Fnmid_unload Unloads the files used by the field tables loaded by the Tux_Fldid function.
Tux_Fidnm_unload Recovers space allocated by the Tux_Fname function for field identifier to field name mapping tables.
Tux_Fchksum Calculates a checksum for extra-reliable I/O and stores it in a fielded buffer.

Refer to the TUXEDO Reference Manual for detailed information, including syntax, parameter and return value descriptions for each function.