Overall parameters of a format session. More...

#include <format.h>

Data Fields
formatField_t *	fields
	Pointer to array of fields to be processed.

int	nfields
	Number of entries in `fields`.

int(*	filter )(const format_t fmt, const formatField_t field)
	This function is called before each field is processed, receiving a pointer to the field being processed and the overall format_t. More...

void *	fieldMap
	Should point to an array with the information that is read by `filter` to decide if a field is or not at the buffer.

int	errorCode
	Last error code during pack / unpack.

formatField_t *	errorField
	Pointer to formatField_t where error was detected. More...

Detailed Description

Overall parameters of a format session.

Field Documentation

formatField_t* format_t::errorField

Pointer to formatField_t where error was detected.

NULL if no error was found during processing, or error was outside a field.

int(* format_t::filter) (const format_t *fmt, const formatField_t *field)

This function is called before each field is processed, receiving a pointer to the field being processed and the overall format_t.

It should return non-zero if the field should be written or read and zero if not.

Parameters

fmt	Descriptor of format instance.
field	Descriptor of field to be formatted.

Returns: Non-zero if field should be read/written.; Zero if field should be ignored.

The documentation for this struct was generated from the following file: