The "Must not be NULL." documentation comments are not consistently structured.
I don't remember which decision I made and so now I am just forcibly setting the same structure with a new line before it.
Improve grammar by adding a dash to de-allocate.
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The second capability to compare.
* @param flags
* (optional) This represents which of the flags that differ on miss.
+ *
* Set to NULL to not use.
*
* @return
* The (external) capability the (internal) capability is copied to.
* @param size
* (optional) The size (in bytes) copied into the (external) capability.
+ *
* Set to NULL to not use.
*
* @return
* The name of the capability (must be all lower case).
* @param code
* (optional) The determined code.
+ *
* Set to NULL to not use.
*
* @return
* Errors (with error bit) from: f_utf_char_to_character().
* @param data
* (optional) A variable passed to the callback, if provided.
+ *
* Set to NULL to not use.
*
* @see f_memory_array_increase_by()
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* This cannot be 0.
* @param read
* (optional) The set of file descriptors for descriptors that become available for reading.
+ *
* Set to NULL to not use.
* @param write
* (optional) The set of file descriptors for descriptors that become available for writing.
+ *
* Set to NULL to not use.
* @param except
* (optional) The set of file descriptors for descriptors that become available for any error conditions.
+ *
* Set to NULL to not use.
* @param timeout
* (optional) The time to wait before returning.
+ *
* Set to NULL to not use.
*
* @return
* This cannot be 0.
* @param read
* (optional) The set of file descriptors for descriptors that become available for reading.
+ *
* Set to NULL to not use.
* @param write
* (optional) The set of file descriptors for descriptors that become available for writing.
+ *
* Set to NULL to not use.
* @param except
* (optional) The set of file descriptors for descriptors that become available for any error conditions.
+ *
* Set to NULL to not use.
* @param timeout
* (optional) The time to wait before returning.
+ *
* Set to NULL to not use.
* @param signal
* (optional) The signals to atomically mask while running the pselect() operation.
* The buffer to write to the file.
* @param written
* (optional) The total bytes written.
+ *
* Set to NULL to not use.
*
* @return
* The buffer to write to the file.
* @param written
* (optional) The total bytes written.
+ *
* Set to NULL to not use.
*
* @return
* The total bytes to write, unless end of buffer is reached first.
* @param written
* (optional) The total bytes written.
+ *
* Set to NULL to not use.
*
* @return
* An inclusive start an stop range within the buffer to read.
* @param written
* (optional) The total bytes written.
+ *
* Set to NULL to not use.
*
* @return
* The buffer to write to the file.
* @param written
* (optional) The total bytes written.
+ *
* Set to NULL to not use.
*
* @return
* The buffer to write to the file.
* @param written
* (optional) The total bytes written.
+ *
* Set to NULL to not use.
*
* @return
* The total bytes to write, unless end of buffer is reached first.
* @param written
* (optional) The total bytes written.
+ *
* Set to NULL to not use.
*
* @return
* An inclusive start an stop range within the buffer to read.
* @param written
* (optional) The total bytes written.
+ *
* Set to NULL to not use.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* @param packet
* The packet extracted from the given buffer, without doing anything to the payload.
* The caller can allocate the payload and extract it at any time by just selecting the string from F_fss_simple_packet_block_header_size_d until at most F_fss_simple_packet_block_payload_size_d.
+ *
* Must not be NULL.
*
* @return
* This buffer is considered binary data and so any NULL found within is treated as a valid part of the buffer.
* @param packet
* The packet range extracted from the given buffer, with the payload being represented by a range.
+ *
* Must not be NULL.
*
* @return
*
* @param simple_packet
* The FSS-000F (Simple Packet) to delete.
+ *
* Must not be NULL.
*
* @return
*
* @param simple_packet
* The FSS-000F (Simple Packet) to destroy.
+ *
* Must not be NULL.
*
* @return
* The size to encode into the size block.
* @param destination
* The string buffer to encode the packet parts into.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
/**
* Check to make sure these two macros are not defined at the same time.
*
- * If _f_memory_FORCE_secure_memory_ is defined, then all to-be deallocated address spaces are set to 0 before freeing or resizing.
- * If _f_memory_FORCE_fast_memory_ is defined, then all to-be deallocated address spaces remain unchanged before freeing or resizing.
+ * If _f_memory_FORCE_secure_memory_ is defined, then all to-be de-allocated address spaces are set to 0 before freeing or resizing.
+ * If _f_memory_FORCE_fast_memory_ is defined, then all to-be de-allocated address spaces remain unchanged before freeing or resizing.
*/
#if defined(_f_memory_FORCE_secure_memory_) && defined(_f_memory_FORCE_fast_memory_)
#error You cannot define both _f_memory_FORCE_fast_memory_ and _f_memory_FORCE_secure_memory_ at the same time.
* Be aware that if a UTF-8 character exists at the end of the string but extends beyond the range stop, the stop position may be after the UTF-8 byte and not 1 byte after the stop point.
* @param id
* (optional) The FLL Identifier found.
+ *
* Set to NULL to not use.
*
* @return
* The signal settings.
* @param action
* (optional) The signal action to use.
+ *
* Set to NULL to not use.
* Both action and previous may not be NULL.
* @param previous
* (optional) The previous signal action.
+ *
* Set to NULL to not use.
*
* @return
* Set this to 0 when only trying to get the current signal set.
* @param next
* (optional) The new set of signals to handle.
+ *
* Set to NULL to not use.
* @param current
* (optional) The current set of signals being handled.
+ *
* Set to NULL to not use.
*
* @return
* The set of signals to wait for.
* @param information
* (optional) The resulting signal information.
+ *
* Set to NULL to not use.
*
* @return
* The amount of time to wait.
* @param information
* (optional) The resulting signal information.
+ *
* Set to NULL to not use.
*
* @return
* (optional) The length of the buffer.
* This gets replaced with the value of a positive ssize_t representing the length read.
* Data may be lost if the amount of data read is larger than given buffer length.
+ *
* Set to NULL to not use.
*
* @return
* (optional) The length of the buffer.
* This gets replaced with the value of a positive ssize_t representing the length read.
* Data may be lost if the amount of data read is larger than given buffer length.
+ *
* Set to NULL to not use.
*
* @return
* (optional) The length of the buffer.
* This gets replaced with the value of a positive ssize_t representing the length send.
* Data may be lost if the amount of data send is larger than given buffer length.
+ *
* Set to NULL to not use.
*
* @return
* (optional) The length of the buffer.
* This gets replaced with the value of a positive ssize_t representing the length send.
* Data may be lost if the amount of data send is larger than given buffer length.
+ *
* Set to NULL to not use.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* Define the constant string type.
*
* This is needed when passing a constant string as a function argument.
- * This cannot be allocated or deallocated.
+ * This cannot be allocated or de-allocated.
* This is provided for compatibility with some projects that return "const char *".
*
* GCC errors such as: "warning: assignment discards ‘const’ qualifier from pointer target type [-Wdiscarded-qualifiers]" can be avoided using this.
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
*
* @param before
* The function to call before forking.
+ *
* Must not be NULL.
* @param after_parent
* The function called after forking, for the parent process.
+ *
* Must not be NULL.
* @param after_child
* The function called after forking, for the child process.
+ *
* Must not be NULL.
*
* @return
* The size of the affinity_set.
* @param affinity_set
* The assigned affinity information.
+ *
* Must not be NULL.
*
* @return
* The affinity information to assign.
* @param attribute
* The thread attributes to update.
+ *
* Must not be NULL.
*
* @return
*
* @param level
* The concurrency level.
+ *
* Must not be NULL.
*
* @return
*
* @param attribute
* The attribute to set.
+ *
* Must not be NULL.
*
* @return
*
* @param attribute
* The thread attributes to process.
+ *
* Must not be NULL.
*
* @return
*
* @param attribute
* The thread attributes to update.
+ *
* Must not be NULL.
*
* @return
*
* @param attribute
* The thread attributes to delete.
+ *
* Must not be NULL.
*
* @return
* The thread attributes to process.
* @param state
* The currently assigned state.
+ *
* Must not be NULL.
*
* @return
* The state to assign (such as PTHREAD_CREATE_DETACHED or PTHREAD_CREATE_JOINABLE).
* @param attribute
* The thread attributes to update.
+ *
* Must not be NULL.
*
* @return
* The thread attributes to process.
* @param guard
* The currently assigned guard size.
+ *
* Must not be NULL.
*
* @return
* The guard size to assign.
* @param attribute
* The thread attributes to update.
+ *
* Must not be NULL.
*
* @return
* The thread attributes to process.
* @param inherit
* The currently assigned scheduler inherit state.
+ *
* Must not be NULL.
*
* @return
* The inherit state of the scheduler (such as PTHREAD_INHERIT_SCHED or PTHREAD_EXPLICIT_SCHED).
* @param attribute
* The thread attributes to update.
+ *
* Must not be NULL.
*
* @return
* The thread attributes to process.
* @param parameter
* The currently assigned scheduler parameters.
+ *
* Must not be NULL.
*
* @return
* The parameters of the scheduler.
* @param attribute
* The thread attributes to update.
+ *
* Must not be NULL.
*
* @return
* The thread attributes to process.
* @param policy
* The currently assigned scheduler policy state.
+ *
* Must not be NULL.
*
* @return
* The policy state of the scheduler (such as SCHED_FIFO, SCHED_RR, or SCHED_OTHER).
* @param attribute
* The thread attributes to update.
+ *
* Must not be NULL.
*
* @return
* The thread attributes to process.
* @param scope
* The currently assigned scheduler scope state.
+ *
* Must not be NULL.
*
* @return
* The scope state of the scheduler (such as PTHREAD_SCOPE_SYSTEM or PTHREAD_SCOPE_PROCESS).
* @param attribute
* The thread attributes to update.
+ *
* Must not be NULL.
*
* @return
* The thread attributes to process.
* @param stack_size
* The size of the stack.
+ *
* Must not be NULL.
* @param stack
* The assigned stack.
+ *
* Must not be NULL.
*
* @return
* The size of the stack.
* @param stack
* The stack to assign.
+ *
* Must not be NULL.
* @param attribute
* The thread attributes to update
* The thread attributes to process.
* @param stack_size
* The assigned size of the stack.
+ *
* Must not be NULL.
*
* @return
* The size of the stack.
* @param attribute
* The thread attributes to update.
+ *
* Must not be NULL.
*
* @return
*
* @param attribute
* The attribute to set.
+ *
* Must not be NULL.
*
* @return
*
* @param attribute
* The thread barrier_attributes to delete.
+ *
* Must not be NULL.
*
* @return
*
* @param attribute
* The barrier thread attribute.
+ *
* Must not be NULL.
* @param shared
* The process shared attribute value.
+ *
* Must not be NULL.
*
* @return
* The process shared attribute value.
* @param attribute
* The barrier thread attribute.
+ *
* Must not be NULL.
*
* @return
* Set to NULL to not use (in which case the default barrier attributes are used).
* @param barrier
* The barrier to set.
+ *
* Must not be NULL.
*
* @return
*
* @param barrier
* The thread barriers to delete.
+ *
* Must not be NULL.
*
* @return
*
* @param barrier
* The barrier to wait on.
+ *
* Must not be NULL.
* @param result
* (optional) the return value, which will be PTHREAD_BARRIER_SERIAL_THREAD for one thread and 0 for others.
+ *
* Set to NULL to not use.
*
* @return
* The cancellation state to assign.
* @param previous
* (optional) The previously assigned cancellation state.
+ *
* Set to NULL to not use.
*
* @return
* The cancellation type to assign.
* @param previous
* (optional) The previously assigned cancellation type.
+ *
* Set to NULL to not use.
* (Note: Linux allows this to be optional/NULL but POSIX does not explicitly defined this and there may be portability issues.)
*
* The ID of the thread to use.
* @param id_clock
* The retrieved clock ID.
+ *
* Must not be NULL.
*
* @return
* @param attribute
* The attribute to set.
* This assigns the default to the attribute.
+ *
* Must not be NULL.
*
* @return
*
* @param attribute
* The thread condition attribute.
+ *
* Must not be NULL.
* @param id
* The clock ID.
+ *
* Must not be NULL.
*
* @return
* The clock ID.
* @param attribute
* The thread condition attribute.
+ *
* Must not be NULL.
*
* @return
*
* @param attribute
* The attribute to delete.
+ *
* Must not be NULL.
*
* @return
*
* @param condition
* The condition to delete.
+ *
* Must not be NULL.
*
* @return
* The wait time is relative to the clock, so consider calling clock_gettime() or gettimeofday() and then adding the amount of wait time.
* @param condition
* The condition to wait on.
+ *
* Must not be NULL.
* @param mutex
* The mutex to use for waiting on condition.
+ *
* Must not be NULL.
*
* @return
* @param id
* The thread ID.
* This gets populated with the created thread ID (aka: the "child" thread).
+ *
* Must not be NULL.
* @param routine
* The function to execute.
+ *
* Must not be NULL.
* @param argument
* (optional) The structure containing all arguments to pass to the routine.
*
* @param result
* The code returned by the exited thread.
+ *
* Must not be NULL.
*
* @return
* @param result
* (optional) The data returned by the terminated thread (usually the exist status).
* If the terminated thread is cancelled, then this holds PTHREAD_CANCELED.
+ *
* Set to NULL to not use.
*
* @return
* @param result
* (optional) The data returned by the terminated thread (usually the exist status).
* If the terminated thread is cancelled, then this holds PTHREAD_CANCELED.
+ *
* Set to NULL to not use.
*
* @return
* @param result
* (optional) The data returned by the terminated thread (usually the exist status).
* If the terminated thread is cancelled, then this holds PTHREAD_CANCELED.
+ *
* Set to NULL to not use.
*
* @return
*
* @param routine
* The function to execute for deallocation/deleting.
+ *
* Must not be NULL.
* @param key
* The thread key.
+ *
* Must not be NULL.
*
* @return
*
* @param key
* The key to delete.
+ *
* Must not be NULL.
*
* @return
* The thread key.
* @param value
* The assigned thread key value.
+ *
* Must not be NULL.
*
* @return
* The thread key.
* @param value
* The thread key value to assign.
+ *
* Must not be NULL.
*
* @return
*
* @param attribute
* The lock attributes to create.
+ *
* Must not be NULL.
*
* @return
*
* @param attribute
* The attribute to delete.
+ *
* Must not be NULL.
*
* @return
*
* @param attribute
* The lock attribute.
+ *
* Must not be NULL.
* @param shared
* The lock shared attribute value.
+ *
* Must not be NULL.
*
* @return
* The lock shared attribute value.
* @param attribute
* The lock attribute.
+ *
* Must not be NULL.
*
* @return
*
* @param attribute
* The lock attribute.
+ *
* Must not be NULL.
* @param lock
* The lock to create.
*
* @param lock
* The lock to delete.
+ *
* Must not be NULL.
*
* @return
*
* @param lock
* The thread lock.
+ *
* Must not be NULL.
*
* @return
*
* @param timeout
* The timeout.
+ *
* Must not be NULL.
* @param lock
* The read/write lock.
+ *
* Must not be NULL.
*
* @return
*
* @param lock
* The thread lock.
+ *
* Must not be NULL.
*
* @return
*
* @param lock
* The thread lock.
+ *
* Must not be NULL.
*
* @return
*
* @param timeout
* The timeout.
+ *
* Must not be NULL.
* @param lock
* The read/write lock.
+ *
* Must not be NULL.
*
* @return
*
* @param lock
* The thread lock.
+ *
* Must not be NULL.
*
* @return
*
* @param attribute
* The mutex attributes to create.
+ *
* Must not be NULL.
*
* @return
*
* @param attribute
* The attribute to delete.
+ *
* Must not be NULL.
*
* @return
*
* @param attribute
* The thread mutex attribute.
+ *
* Must not be NULL.
* @param ceiling
* The priority ceiling.
+ *
* Must not be NULL.
*
* @return
* The priority ceiling.
* @param attribute
* The thread mutex attribute.
+ *
* Must not be NULL.
*
* @return
*
* @param attribute
* The thread mutex attribute.
+ *
* Must not be NULL.
* @param protocol
* The protocol.
+ *
* Must not be NULL.
*
* @return
* The protocol.
* @param attribute
* The thread mutex attribute.
+ *
* Must not be NULL.
*
* @return
*
* @param attribute
* The mutex attribute.
+ *
* Must not be NULL.
* @param shared
* The mutex shared attribute value.
+ *
* Must not be NULL.
*
* @return
* The mutex shared attribute value.
* @param attribute
* The mutex attribute.
+ *
* Must not be NULL.
*
* @return
*
* @param attribute
* The mutex attribute.
+ *
* Must not be NULL.
* @param type
* The type.
+ *
* Must not be NULL.
*
* @return
* The type.
* @param attribute
* The mutex attribute.
+ *
* Must not be NULL.
*
* @return
* Set to NULL to not use (in which case the default attributes are used).
* @param mutex
* The mutex to create.
+ *
* Must not be NULL.
*
* @return
*
* @param mutex
* The mutex to delete.
+ *
* Must not be NULL.
*
* @return
*
* @param mutex
* The thread mutex.
+ *
* Must not be NULL.
* @param ceiling
* The priority ceiling.
+ *
* Must not be NULL.
*
* @return
* The priority ceiling.
* @param mutex
* The thread mutex.
+ *
* Must not be NULL.
* @param previous
* (optional) The previous priority ceiling.
+ *
* Set to NULL to not use.
*
* @return
*
* @param mutex
* The thread mutex.
+ *
* Must not be NULL.
*
* @return
*
* @param mutex
* The thread mutex.
+ *
* Must not be NULL.
*
* @return
*
* @param timeout
* The timeout.
+ *
* Must not be NULL.
* @param mutex
* The thread mutex.
+ *
* Must not be NULL.
*
* @return
*
* @param mutex
* The thread mutex.
+ *
* Must not be NULL.
*
* @return
* The callback.
* @param once
* The once variable designating that the given routine will be called only once.
+ *
* Must not be NULL.
*
* @return
* The value to initially assign the semaphore on creation.
* @param semaphore
* The semaphore to create.
+ *
* Must not be NULL.
*
* @return
*
* @param semaphore
* The semaphore to delete.
+ *
* Must not be NULL.
*
* @return
*
* @param semaphore
* The semaphore to delete.
+ *
* Must not be NULL.
*
* @return
* Ignored if O_CREAT is not used in flag.
* Ignored if the named semaphore already exists.
* Not optional when O_CREAT flag is set.
+ *
* Set to NULL to not use.
* @param value
* (optional) The value to initially assign the semaphore on creation.
* Ignored when mode is NULL.
* @param semaphore
* The thread semaphore.
+ *
* Must not be NULL.
*
* @return
*
* @param semaphore
* The thread semaphore.
+ *
* Must not be NULL.
*
* @return
* The timeout.
* @param semaphore
* The thread semaphore.
+ *
* Must not be NULL.
*
* @return
*
* @param semaphore
* The thread semaphore.
+ *
* Must not be NULL.
*
* @return
*
* @param semaphore
* The thread semaphore.
+ *
* Must not be NULL.
*
* @return
*
* @param semaphore
* The thread semaphore.
+ *
* Must not be NULL.
* @param value
* The semaphore's value.
+ *
* Must not be NULL.
*
* @return
* Set this to 0 when only trying to get the current signal set.
* @param next
* (optional) The new set of signals to handle.
+ *
* Set to NULL to not use.
* @param current
* (optional) The current set of signals being handled.
+ *
* Set to NULL to not use.
*
* @return
* The shared process setting.
* @param spin
* The spin to create.
+ *
* Must not be NULL.
*
* @return
*
* @param spin
* The spin to delete.
+ *
* Must not be NULL.
*
* @return
*
* @param spin
* The thread spin.
+ *
* Must not be NULL.
*
* @return
*
* @param spin
* The thread spin.
+ *
* Must not be NULL.
*
* @return
*
* @param spin
* The thread spin.
+ *
* Must not be NULL.
*
* @return
*
* @param lock
* The thread lock.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The time to sleep (in seconds and nanoseconds).
* @param remaining
* (optional) Contains the remaining time if stopped on interrupt.
+ *
* Set to NULL to not use.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* Can be anything greater than 0.
* @param value
* (optional) The integer representation of the sequence if the sequence represents a decimal of any base type.
+ *
* Set to NULL to not use.
*
* @return
* Can be anything greater than 0.
* @param value
* (optional) The integer representation of the sequence if the sequence represents a decimal of any base type.
+ *
* Set to NULL to not use.
*
* @return
* The byte sequence to validate as a character.
* @param value
* (optional) The integer representation of the sequence if the sequence represents a decimal of any base type.
+ *
* Set to NULL to not use.
*
* @return
* The byte sequence to validate as a character.
* @param value
* (optional) The integer representation of the sequence if the sequence represents a decimal of any base type.
+ *
* Set to NULL to not use.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
/**
* A string that is analogous to f_utf_string_dynamic_t but intended for static-only uses.
*
- * The f_utf_string_static_t type should never be directly allocated or deallocated.
+ * The f_utf_string_static_t type should never be directly allocated or de-allocated.
*
* A special macro_f_utf_string_static_t_initialize_1() is provided for the special purpose of easily initialize a static string.
* A special macro_f_utf_string_static_t_initialize_2() is provided for the special purpose of easily initialize a static string with an identical used and size.
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* The exclusive stop position in the array to stop deleting.
* @param array
* The array structure to delete all values of.
+ *
* Must not be NULL.
*
* @return
* A location where a valid object was found.
* @param quote
* (optional) This will store the quote type representing the character to use (from the f_fss_quote_type_*_e).
+ *
* Set to NULL to not use.
* @param delimits
* A delimits array representing where delimits exist within the buffer.
* @param prepend
* (optional) A string of whitespace to prepend at the start of each line.
* This should only be whitespace, anything else could produce invalid content.
+ *
* Set to NULL to not use.
* @param range
* The start/stop location within the content string to write as an content.
* @param prepend
* (optional) A string of whitespace to prepend at the start of each line.
* This should only be whitespace, anything else could produce invalid content.
+ *
* Set to NULL to not use.
* @param ignore
* (optional) A list of ranges within the string to ignore.
* These ranges are only checked/ignored if there is a valid nested object open or a valid nested object close.
* Any valid nested object open or valid nested object close inside an ingore range will not be escaped.
+ *
* Set to NULL to not use.
* @param range
* The start/stop location within the content string to write as an content.
* @param quotes
* (optional) This will store the quote type representing the character to use (from the f_fss_quote_type_*_e).
* Each index in quotes represents a position within the found array index.
+ *
* Set to NULL to not use.
* @param delimits
* A delimits array representing where delimits exist within the buffer.
* A location where a valid object was found.
* @param quote
* (optional) This will store the quote type representing the character to use (from the f_fss_quote_type_*_e).
+ *
* Set to NULL to not use.
* @param delimits
* A delimits array representing where delimits exist within the buffer.
* @param prepend
* (optional) A string of whitespace to prepend at the start of each line.
* This should only be whitespace, anything else could produce invalid content.
+ *
* Set to NULL to not use.
* @param ignore
* (optional) A list of ranges within the string to ignore.
* These ranges are only checked/ignored if there is a valid nested object open or a valid nested object close.
* Any valid nested object open or valid nested object close inside an ingore range will not be escaped.
+ *
* Set to NULL to not use.
* @param range
* The start/stop location within the content string to write as an content.
* A set of all locations where a valid object was found.
* @param quote
* (optional) This will store the quote type representing the character to use (from the f_fss_quote_type_*_e).
+ *
* Set to NULL to not use.
* @param delimits
* An array of delimits detected during processing.
* Errors (with error bit) from: f_utf_buffer_increment().
* @param internal
* (optional) Used by certain functions to pass local data to the interrupt() and similar callbacks.
+ *
* Set to NULL to not use.
*
* @see f_fss_is_space()
* (optional) The execute status code returned after finishing or attempting to finish execution of program.
* When FL_execute_parameter_option_return_d is passed via parameter.option, then this instead stores the child process id (PID).
* This is should be of (int *) except when FL_execute_parameter_option_return_d this should instead be (pid_t *).
+ *
* Set to NULL to not use.
*
* @return
* On success, the range->start should be after the last valid position (for example for "# fss-1234 fss-4321\n", the ast valid position would be the byte after the "\n").
* @param ids
* (optional) The FLL Identifiers to populate with results of this function.
+ *
* Set to NULL to not use.
*
* When non-NULL, this will have its length reset to 0.
* An array of values where "snatched" content is stored.
* @param matches
* (optional) An array representing the if an Object was matched.
+ *
* Set to NULL to not use.
* @param indexs
* (optional) An array representing the index within the Objects where the Content match was made.
+ *
* Set to NULL to not use.
*
* @return
* An array of values where "snatched" content is stored.
* @param matches
* (optional) An array representing the if an Object was matched.
+ *
* Set to NULL to not use.
* @param indexs
* (optional) An array representing the index within the Objects where the Content match was made.
+ *
* Set to NULL to not use.
*
* @return
* An array of map arrays where "snatched" content is stored.
* @param matches
* (optional) An array representing the if an Object was matched.
+ *
* Set to NULL to not use.
* @param indexs
* (optional) An array representing the index within the Objects where the Content match was made.
+ *
* Set to NULL to not use.
*
* @return
* An array of multi map arrays where "snatched" content is stored.
* @param matches
* (optional) An array representing the if an Object was matched.
+ *
* Set to NULL to not use.
* @param indexs
* (optional) An array representing the index within the Objects where the Content match was made.
+ *
* Set to NULL to not use.
*
* @return
* An array of multi map value arrays where "snatched" content is stored.
* @param matches
* (optional) An array representing the if an Object was matched.
+ *
* Set to NULL to not use.
* @param indexs
* (optional) An array representing the index within the Objects where the Content match was made.
+ *
* Set to NULL to not use.
*
* @return
* An array of multi map value arrays where "snatched" content is stored.
* @param matches
* (optional) An array representing the if an Object was matched.
+ *
* Set to NULL to not use.
* @param indexs
* (optional) An array representing the index within the Objects where the Content match was made.
+ *
* Set to NULL to not use.
*
* @return
* An array of map arrays where "snatched" content is stored.
* @param matches
* (optional) An array representing the if an Object was matched.
+ *
* Set to NULL to not use.
* @param indexs
* (optional) An array representing the index within the Objects where the Content match was made.
+ *
* Set to NULL to not use.
*
* @return
* An array of values where "snatched" content is stored.
* @param matches
* (optional) An array representing the if an Object was matched.
+ *
* Set to NULL to not use.
* @param indexs
* (optional) An array representing the index within the Objects where the Content match was made.
+ *
* Set to NULL to not use.
*
* @return
* An array of values where "snatched" content is stored.
* @param matches
* (optional) An array representing the if an Object was matched.
+ *
* Set to NULL to not use.
* @param indexs
* (optional) An array representing the index within the Objects where the Content match was made.
+ *
* Set to NULL to not use.
*
* @return
* An array of values where "snatched" content is stored.
* @param matches
* (optional) An array representing the if an Object was matched.
+ *
* Set to NULL to not use.
* @param indexs
* (optional) An array representing the index within the Objects where the Content match was made.
+ *
* Set to NULL to not use.
*
* @return
* This will be populated with all valid contents found.
* @param objects_quoted
* (optional) An array mapped to each object in objects representing the quote type discovered (from the f_fss_quote_type_*_e), if any.
+ *
* Set to NULL to not use.
* @param objects_delimits
* An array of delimits for objects detected during processing.
* A string representing the content.
* @param content_prepend
* (optional) A string to prepend at the start of each line in content, such as spaces.
+ *
* Set to NULL to not use.
* @param destination
* The buffer to write to.
* A string representing the content.
* @param content_prepend
* (optional) A string to prepend at the start of each line in content, such as spaces.
+ *
* Set to NULL to not use.
* @param ignore
* (optional) A list of ranges within the string to ignore.
* These ranges are only checked/ignored if there is a valid nested object open or a valid nested object close.
* Any valid nested object open or valid nested object close inside an ingore range will not be escaped.
+ *
* Set to NULL to not use.
* @param destination
* The buffer where the content is written to.
* This will be populated with all valid contents found.
* @param objects_quoted
* (optional) An array mapped to each object in objects representing the quote type discovered (from the f_fss_quote_type_*_e), if any.
+ *
* Set to NULL to not use.
* @param contents_quoted
* (optional) An array mapped to each content in objects representing the quote type discovered (from the f_fss_quote_type_*_e), if any.
+ *
* Set to NULL to not use.
* @param objects_delimits
* An array of delimits for objects detected during processing.
* A string representing the content.
* @param content_prepend
* (optional) A string to prepend at the start of each line in content, such as spaces.
+ *
* Set to NULL to not use.
* @param ignore
* (optional) A list of ranges within the string to ignore.
* These ranges are only checked/ignored if there is a valid nested object open or a valid nested object close.
* Any valid nested object open or valid nested object close inside an ingore range will not be escaped.
+ *
* Set to NULL to not use.
* @param destination
* The buffer where the content is written to.
* @param content_prepend
* (optional) A string to prepend at the start of each line in content, such as spaces.
* This will not be prepended for the Object "payload".
+ *
* Set to NULL to not use.
* @param destination
* The buffer to append to.
* The variable arguments list.
* @param status
* The status is stored here rather then via the return.
+ *
* Set to NULL to not use.
*
* @return
* The primary color context to assign.
* @param sets
* (optional) A NULL terminated array representing additional sets to assign as empty.
+ *
* Set to NULL to not use.
*
* @return
* - output: The output file for normal/non-message output, aka data output (often stdout or a file).
* - error: The output file for error output messages.
* - warning: The output file for warning output messages.
+ * - debug: The output file for debug output messages.
*
* - context: The color context.
*/
#endif // _di_byte_dump_main_t_
/**
- * Deallocate main program data.
+ * De-allocate main program data.
*
* @param main
* The main program data.
#endif // _di_controller_main_t_
/**
- * Deallocate main program data.
+ * De-allocate main program data.
*
* @param main
* The main program data.
#endif // _di_controller_setting_load_
/**
- * Fully deallocate all memory for the given entry action without caring about return status.
+ * Fully de-allocate all memory for the given entry action without caring about return status.
*
* @param action
- * The action to deallocate.
+ * The action to de-allocate.
*
* @see f_memory_arrays_resize()
*
#endif // _di_controller_entry_action_delete_
/**
- * Fully deallocate all memory for the given entry actions without caring about return status.
+ * Fully de-allocate all memory for the given entry actions without caring about return status.
*
* @param actions
- * The entry_actions to deallocate.
+ * The entry_actions to de-allocate.
*
* @return
* F_okay on success.
#endif // _di_controller_entry_actions_increase_by_
/**
- * Fully deallocate all memory for the given entry item without caring about return status.
+ * Fully de-allocate all memory for the given entry item without caring about return status.
*
* @param item
- * The item to deallocate.
+ * The item to de-allocate.
*
* @return
* F_okay on success.
#endif // _di_controller_entry_item_delete_
/**
- * Fully deallocate all memory for the given entry items without caring about return status.
+ * Fully de-allocate all memory for the given entry items without caring about return status.
*
* @param items
- * The entry_items to deallocate.
+ * The entry_items to de-allocate.
*
* @return
* F_okay on success.
#endif // _di_controller_entry_items_increase_by_
/**
- * Fully deallocate all memory for the given Rule Action without caring about return status.
+ * Fully de-allocate all memory for the given Rule Action without caring about return status.
*
* @param action
- * The action to deallocate.
+ * The action to de-allocate.
*
* @see f_memory_arrays_resize()
*/
#endif // _di_controller_rule_action_delete_
/**
- * Fully deallocate all memory for the given Rule Actions without caring about return status.
+ * Fully de-allocate all memory for the given Rule Actions without caring about return status.
*
* @param actions
- * The rule_actions to deallocate.
+ * The rule_actions to de-allocate.
*
* @see controller_rule_action_delete()
* @see f_memory_delete()
#endif // _di_controller_rule_actions_increase_by_
/**
- * Fully deallocate all memory for the given Rule without caring about return status.
+ * Fully de-allocate all memory for the given Rule without caring about return status.
*
* @param rule
- * The rule to deallocate.
+ * The rule to de-allocate.
*
* @see controller_rule_items_delete()
* @see f_capability_delete()
#endif // _di_controller_rule_delete_
/**
- * Fully deallocate all memory for the given Rule Item without caring about return status.
+ * Fully de-allocate all memory for the given Rule Item without caring about return status.
*
* @param item
- * The item to deallocate.
+ * The item to de-allocate.
*
* @see f_memory_array_resize()
*/
#endif // _di_controller_rule_item_delete_
/**
- * Fully deallocate all memory for the given Rule Items without caring about return status.
+ * Fully de-allocate all memory for the given Rule Items without caring about return status.
*
* @param items
- * The rule_items to deallocate.
+ * The rule_items to de-allocate.
*
* @see controller_rule_item_delete()
* @see f_memory_delete()
#endif // _di_controller_rule_items_delete_
/**
- * Fully deallocate all memory for the given Rule Item without caring about return status.
+ * Fully de-allocate all memory for the given Rule Item without caring about return status.
*
* @param on
- * The on to deallocate.
+ * The on to de-allocate.
*
* @see f_memory_array_resize()
*/
#endif // _di_controller_rule_on_delete_
/**
- * Fully deallocate all memory for the given Rule Items without caring about return status.
+ * Fully de-allocate all memory for the given Rule Items without caring about return status.
*
* @param ons
- * The rule_ons to deallocate.
+ * The rule_ons to de-allocate.
*
* @see controller_rule_on_delete()
* @see f_memory_delete()
#endif // _di_controller_rule_ons_resize_
/**
- * Fully deallocate all memory for the given Rules without caring about return status.
+ * Fully de-allocate all memory for the given Rules without caring about return status.
*
* @param rules
- * The rules to deallocate.
+ * The rules to de-allocate.
*
* @see controller_rules_resize()
*/
#endif // _di_controller_cache_t_
/**
- * Fully deallocate all memory for the given cache without caring about return status.
+ * Fully de-allocate all memory for the given cache without caring about return status.
*
* @param cache
- * The cache to deallocate.
+ * The cache to de-allocate.
*
* @see f_memory_array_resize()
*/
#endif // _di_controller_cache_action_delete_simple_
/**
- * Fully deallocate all memory for the given cache without caring about return status.
+ * Fully de-allocate all memory for the given cache without caring about return status.
*
* @param cache
- * The cache to deallocate.
+ * The cache to de-allocate.
*
* @see controller_cache_action_delete_simple()
*
#endif // _di_controller_lock_delete_rw_
/**
- * Fully deallocate all memory for the given lock without caring about return status.
+ * Fully de-allocate all memory for the given lock without caring about return status.
*
* @param lock
- * The lock to deallocate.
+ * The lock to de-allocate.
*
* @see f_thread_lock_delete()
* @see f_thread_mutex_delete()
#endif // _di_controller_pids_resize_
/**
- * Fully deallocate all memory for the given process without caring about return status.
+ * Fully de-allocate all memory for the given process without caring about return status.
*
* @param data
- * The data to deallocate.
+ * The data to de-allocate.
*
* @see f_memory_array_resize()
* @see f_thread_condition_delete()
#endif // _di_controller_data_delete_simple_
/**
- * Fully deallocate all memory for the given processs without caring about return status.
+ * Fully de-allocate all memory for the given processs without caring about return status.
*
* @param processs
- * The process array to deallocate.
+ * The process array to de-allocate.
*
* @see controller_processs_resize()
*/
#endif // _di_controller_thread_t_
/**
- * Fully deallocate all memory for the given setting without caring about return status.
+ * Fully de-allocate all memory for the given setting without caring about return status.
*
* @param thread
- * The thread to deallocate.
+ * The thread to de-allocate.
*
* @see controller_asynchronouss_resize()
* @see f_thread_mutex_unlock()
* The Rule alias to use.
* @param id
* (optional) The process ID when found or created.
+ *
* Set to NULL to not use.
*
* @return
* The Rule alias to use.
* @param id
* (optional) The process ID when found or created.
+ *
* Set to NULL to not use.
*
* @return
}
}
- // Deallocate dynamic portions of the structure that are only ever needed while the process is running.
+ // De-allocate dynamic portions of the structure that are only ever needed while the process is running.
controller_cache_delete_simple(&process->cache);
f_memory_array_resize(0, sizeof(f_number_unsigned_t), (void **) &process->stack.array, &process->stack.used, &process->stack.size);
}
}
- // Deallocate the PID files.
+ // De-allocate the PID files.
if (process->path_pids.used) {
process->path_pids.used = 0;
f_memory_arrays_resize(0, sizeof(f_string_dynamic_t), (void **) &process->path_pids.array, &process->path_pids.used, &process->path_pids.size, &f_string_dynamics_delete_callback);
}
- // Deallocate any rules in the space that is declared to be unused.
+ // De-allocate any rules in the space that is declared to be unused.
if (i >= global->thread->processs.used) {
controller_rule_delete(&process->rule);
}
if (status == F_child) {
- // A forked child process should deallocate memory on exit.
+ // A forked child process should de-allocate memory on exit.
// It seems that this function doesn't return to the calling thread for a forked child process, even with the "return 0;" below.
- // Deallocate as much as possible.
+ // De-allocate as much as possible.
controller_thread_delete_simple(global->thread);
controller_process_delete(global->setting);
controller_main_delete(global->main);
if (*status == F_child) {
- // A forked child process should deallocate memory on exit.
+ // A forked child process should de-allocate memory on exit.
// It seems that this function doesn't return to the calling thread for a forked child process, even with the "return 0;" below.
- // Deallocate as much as possible.
+ // De-allocate as much as possible.
controller_thread_delete_simple(entry->global->thread);
controller_process_delete(entry->global->setting);
controller_main_delete(entry->global->main);
if (*status == F_child) {
- // A forked child process should deallocate memory on exit.
+ // A forked child process should de-allocate memory on exit.
// It seems that this function doesn't return to the calling thread for a forked child process, even with the "return 0;" below.
- // Deallocate as much as possible.
+ // De-allocate as much as possible.
controller_thread_delete_simple(entry->global->thread);
controller_process_delete(entry->global->setting);
controller_main_delete(entry->global->main);
if (status == F_child) {
- // A forked child process should deallocate memory on exit.
+ // A forked child process should de-allocate memory on exit.
// It seems that this function doesn't return to the calling thread for a forked child process, even with the "return 0;" below.
- // Deallocate as much as possible.
+ // De-allocate as much as possible.
controller_main_t *main = (controller_main_t *) process->main_data;
controller_process_t *setting = (controller_process_t *) process->main_setting;
controller_thread_t *thread = (controller_thread_t *) process->main_thread;
#endif // _di_example_main_t_
/**
- * Deallocate main program data.
+ * De-allocate main program data.
*
* @param cache
* The program cache.
#endif // _di_example_cache_delete_
/**
- * Deallocate main program data.
+ * De-allocate main program data.
*
* @param main
* The main program data.
#endif // _di_fake_build_stage_delete_
/**
- * Deallocate program data.
+ * De-allocate program data.
*
* @param data
* The program data.
#endif // _di_fake_data_delete_
/**
- * Deallocate make data.
+ * De-allocate make data.
*
* @param data_make
* The make data.
#endif // _di_fake_make_data_delete_
/**
- * Deallocate main program data.
+ * De-allocate main program data.
*
* @param main
* The main program data.
#endif // _di_fake_main_delete_
/**
- * Deallocate make setting data.
+ * De-allocate make setting data.
*
* @param setting_make
* The make setting data.
#endif // _di_firewall_main_t_
/**
- * Deallocate firewall cache.
+ * De-allocate firewall cache.
*
* @param cache
* The firewall cache.
#endif // _di_firewall_cache_delete_
/**
- * Deallocate firewall data.
+ * De-allocate firewall data.
*
* @param data
* The firewall data.
#endif // _di_firewall_data_delete_
/**
- * Deallocate main program data.
+ * De-allocate main program data.
*
* @param main
* The main program data.
#endif // _di_fss_identify_main_t_
/**
- * Deallocate main program data.
+ * De-allocate main program data.
*
* @param main
* The main program data.
#endif // _di_fss_read_main_t_
/**
- * Deallocate the read depth.
+ * De-allocate the read depth.
*
* @param depth
- * The depth to deallocate.
+ * The depth to de-allocate.
*
* Must not be NULL.
*
#endif // _di_fss_read_files_resize_
/**
- * Deallocate main program data.
+ * De-allocate main program data.
*
* @param main
* The program and settings data.
#endif // _di_fss_write_main_t_
/**
- * Deallocate main program data.
+ * De-allocate main program data.
*
* @param main
* The main program data.
#endif // _di_iki_read_main_t_
/**
- * Deallocate main program data.
+ * De-allocate main program data.
*
* @param main
* The main program data.
#endif // _di_iki_write_main_t_
/**
- * Deallocate main program data.
+ * De-allocate main program data.
*
* @param main
* The main program data.
#endif // _di_status_code_main_t_
/**
- * Deallocate main program data.
+ * De-allocate main program data.
*
* @param main
* The main program data..
#endif // _di_utf8_main_t_
/**
- * Deallocate main program data.
+ * De-allocate main program data.
*
* @param main
* The main program data.
projects / fll / commitdiff