Chapter B1
Functions Alphabetically

Here the functions are listed alphabetically within each section.

B1.1 Miscellaneous Functions

Util_CurrentDate

[B14] Fills string with current local date

Util_CurrentDateTime

[B15] Returns the current datetime in a machine-processable format as defined in ISO 8601 chapter 5.4.

Util_CurrentTime

[B17] Fills string with current local time

Util_snprintf

[B19] Safely format data into a caller-supplied buffer.

Util_vsnprintf

[B24] Safely format data into a caller-supplied buffer.

B1.2 String Functions

Util_StrCmpi

[B27] Compare two strings, ignoring upper/lower case.

Util_Strdup

[B33] “Duplicate” a string, i.e. copy it to a newly–malloced buffer.

Util_Strlcat

[B36] Concatenate two strings safely.

Util_Strlcpy

[B40] Copy a string safely.

Util_StrSep

[B45] Separate first token from a string.

B1.3 Table Functions

Util_TableClone

[B52] Create a new table which is a “clone” (exact copy) of an existing table

Util_TableCreate

[B57] Create a new (empty) table

Util_TableCreateFromString

[B61] Create a new table (with the case-insensitive flag set) and sets values in it based on a string argument (interpreted with “parameter-file” semantics)

Util_TableDeleteKey

[B65] Delete a specified key/value entry from a table

Util_TableDestroy

[B67] Destroy a table

Util_TableGet*

[B71] This is a family of functions, one for each Cactus data type, to get the single (1-element array) value, or more generally the first array element of the value, associated with a specified key in a key/value table.

Util_TableGet*Array

[B75] This is a family of functions, one for each Cactus data type, to get a copy of the value associated with a specified key, and store it (more accurately, as much of it as will fit) in a specified array

Util_TableGetGeneric

[B79] Get the single (1-element array) value, or more generally the first array element of the value, associated with a specified key in a key/value table; the value’s data type is generic

Util_TableGetGenericArray

[B83] Get a copy of the value associated with a specified key, and store it (more accurately, as much of it as will fit) in a specified array; the array’s data type is generic

Util_TableGetString

[B87] Gets a copy of the character-string value associated with a specified key in a table, and stores it (more accurately, as much of it as will fit) in a specified character string

Util_TableItAdvance

[B90] Advance a table iterator to the next entry in the table

Util_TableItClone

[B92] Creates a new table iterator which is a “clone” (exact copy) of an existing table iterator

Util_TableItCreate

[B96] Create a new table iterator

Util_TableItDestroy

[B98] Destroy a table iterator

Util_TableItQueryIsNonNull

[B100] Query whether a table iterator is not in the “null-pointer” state

Util_TableItQueryIsNull

[B103] Query whether a table iterator is in the “null-pointer” state

Util_TableItQueryKeyValueInfo

[B106] Query the key and the type and number of elements of the value corresponding to that key, of the table entry to which an iterator points

Util_TableItQueryTableHandle

[B110] Query what table a table iterator iterates over

Util_TableItResetToStart

[B112] Reset a table iterator to point to the starting table entry

Util_TableItSetToKey

[B114] Set a key/value iterator to point to a specified entry in the table.

Util_TableItSetToNull

[B116] Set a key/value iterator to the “null-pointer” state.

Util_TableQueryFlags

[B118] Query a table’s flags word

Util_TableQueryValueInfo

[B121] Query whether or not a specified key is in the table, and optionally the type and/or number of elements of the value corresponding to this key

Util_TableQueryMaxKeyLength

[B125] Query the maximum key length in a table

Util_TableQueryNKeys

[B129] Query the number of key/value entries in a table

Util_TableSet*

[B131] This is a family of functions, one for each Cactus data type, to set the value associated with a specified key to be a specified single (1-element array) value

Util_TableSet*Array

[B135] This is a family of functions, one for each Cactus data type, to set the value associated with a specified key to be a copy of a specified array

Util_TableSetFromString

[B139] Sets values in a table based on a string argument (interpreted with “parameter-file” semantics)

Util_TableSetGeneric

[B144] Set the value associated with a specified key to be a specified single (1-element array) value, whose data type is generic

Util_TableSetGenericArray

[B148] Set the value associated with a specified key to be a copy of a specified array, whose data type is generic

Util_TableSetString

[B152] Sets the value associated with a specified key in a table, to be a copy of a specified C-style null-terminated character string