PURPOSE

Findex, Findex32 - index a fielded buffer

SYNOPSIS

#include <stdio.h>
#include "fml.h"
int
Findex(FBFR *fbfr, FLDOCC intvl)
#include "fml32.h"
int
Findex32(FBFR32 *fbfr, FLDOCC32 intvl)

DESCRIPTION

The function Findex(\|) is called explicitly to index a fielded buffer. fbfr is a pointer to a fielded buffer. The second parameter, intvl, gives the indexing interval, that is, the ideal separation of indexed fields. If this argument has value 0, then the buffer's current indexing value is used. If the current value itself is 0, the value FSTDXINTVL (defaults to 16) is used. Using an indexing value of 1 will ensure that every field in the buffer is indexed. The size of the index interval and the amount of space allocated to a buffer's index are inversely proportional: the smaller the interval, the more fields are indexed and thus the larger the amount of space used for indexing.

Findex32 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, Findex() 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().

[FNOSPACE]

"no space in fielded buffer" An ENTRY is to be added to the index but there is not enough space remaining in the buffer.

SEE ALSO

Fintro(3fml),
Fidxused(3fml),
Frstrindex(3fml),
Funindex(3fml)