[Home] [Back] [Up] [<<] [>>]

StateField

The name of the field that contains the state (often "State").
See State field.
This field name must already exist; ie. first set the field names, then set this property.
If this field is not set, or is set to empty, then Manifest Report and the Lodgement Information will not include unbarcoded mail.

Syntax

int reportGetStateField(char *s);

int reportPutStateField(const char *sFieldName);

Syntax description

spointer to the buffer to receive the field name. This buffer should be at least MAX_FIELD_NAME + 1 characters in length. If no field has been specified, then s will set to an empty string
sFieldNamenull-terminated string specifying the field name.
Return values

The Get function returns zero.
The Put function returns zero on success, and an error if the field doesn’t exist.