---

Fidxused (3FML)

Name

Fidxused, Fidxused32-return amount of space used

Synopsis

#include <stdio.h>  
#include "fml.h"  
long  
Fidxused(FBFR *fbfr)  
#include "fml32.h"  
long  
Fidxused32(FBFR32 *fbfr)

Description

Fidxused() indicates the current amount of space used by the buffer's index. fbfr is a pointer to a fielded buffer.

Fidxused32 is used with 32-bit FML.

Return Values

On success, the function returns the amount of space in the buffer used by the index. This function returns -1 on error and sets Ferror to indicate the error condition.

Errors

Under the following conditions, Fidxused() 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().

See Also

Fintro(3), Findex(3), Frstrindex(3), Funused(3), Fused(3)

---

---