DBF INDEXORDER()
From Recital Documentation Wiki
Revision as of 10:35, 30 March 2009 by Yvonnemilne (Talk | contribs)
PURPOSE
Return current master index number
SYNONYM
api_dbf_indexorder()
SYNOPSIS
#include "dbapi.h" int DBF_INDEXORDER() <input parameters> none <output parameters> none
DESCRIPTION
The DBF_INDEXORDER() function will return the master index from the currently selected database as an integer, if no index is active then -1 will be returned
A value from 1 to 20 will can be returned depending on the current master index. If the index is set to natural order, a value of 0 will be returned.
EXAMPLE
The following example returns the master index for the current database.
#include "dbapi.h" dbapi_dbf_indexorder() { int master; master = DBF_INDEXORDER(); _retni( master ); }
SEE ALSO
COMMAND(), DBF_ALIAS(), DBF_DBF(), DBF_DELETED(), DBF_FETCH(), DBF_FILTER(), DBF_FMT(), DBF_INDEXKEY(), DBF_NDX(), DBF_SEEK(), DBF_SELECT(), DBF_SKIP(), FIELD_COUNT(), FIELD_LOOKUP()