|
|
Fidxused, Fidxused32(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.
A thread in a multithreaded application may issue a call to Fidxused() or Fidxused32() while running in any context state, including TPINVALIDCONTEXT.
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:
The buffer does not begin on the proper boundary.
The buffer is not a fielded buffer or has not been initialized by Finit().
See Also
Introduction to FML Functions, Findex, Findex32(3fml), Frstrindex, Frstrindex32(3fml), Funused, Funused32(3fml), Fused, Fused32(3fml)
|
Copyright © 2000 BEA Systems, Inc. All rights reserved.
|