PURPOSE

Fgets, Fgets32 - get value converted to string

SYNOPSIS

#include <stdio.h>
#include "fml.h"
int
Fgets(FBFR *fbfr, FLDID fieldid, FLDOCC oc, char *buf)
#include "fml32.h"
int
Fgets32(FBFR32 *fbfr, FLDID32 fieldid, FLDOCC32 oc, char *buf)

DESCRIPTION

Fgets(\|) retrieves a field occurrence from the fielded buffer first converting the value to a user type of FLD_STRING. fbfr is a pointer to a fielded buffer. fieldid is a field identifier. oc is the occurrence number of the field. The caller of Fgets() provides buf, a pointer to a private buffer, which is used for the retrieved field value. It is assumed that buf is large enough to hold the value. Basically, Fgets() calls CFget(3c) with an assumed utype of FLD_STRING, and a ulen of 0.

Fgets32 is used with 32-bit FML.

RETURN VALUES

This function returns \-1 on error and sets Ferror to indicate the error condition.

ERRORS

Under the following conditions, Fgets() fails and sets Ferror to:

[FALIGNERR]

"fielded buffer not aligned" The buffer does not begin on the proper boundary.

[FNOTFLD]

"buffer not fielded" The buffer is not a fielded buffer or has not been initialized by Finit().

[FNOTPRES]

"field not present" A field occurrence is requested but the specified field and/or occurrence was not found in the fielded buffer.

[FBADFLD]

"unknown field number or type" A field identifier is specified which is not valid.

[FTYPERR]

"invalid field type" A field identifier is specified which is not valid.

[FMALLOC]

"malloc failed" Allocation of space dynamically using malloc(3) failed.

SEE ALSO

Fintro(3fml),
CFget(3c),
Fget(3fml),
Fgetalloc(3fml),
Fgetlast(3fml),
Fgetsa(3fml)