DBF NDX()
From Recital Documentation Wiki
Revision as of 10:24, 30 March 2009 by Yvonnemilne (Talk | contribs)
PURPOSE
Return index name
SYNONYM
api_dbf_ndx()
SYNOPSIS
#include "dbapi.h" char *DBF_NDX(order) <input parameters> long order; /* Index order */ <output parameters> none
DESCRIPTION
The DBF_NDX() function will return the index name from the currently selected database for the specified index order as a character string, if no index is active then a NULL string will be returned.
The character string is returned in lower case including the file extension
EXAMPLE
The following example returns the index name for the specified order.
#include "dbapi.h" dbapi_dbf_ndx() { char *indexname; if (_parinfo(1) == API_NTYPE ) { indexname = DBF_NDX( _parni(1) ); } else { strcpy(indexname, ""); } _retc( indexname ); }
SEE ALSO
COMMAND(), DBF_ALIAS(), DBF_DBF(), DBF_DELETED(), DBF_FETCH(), DBF_FILTER(), DBF_FMT(), DBF_INDEXKEY(), DBF_INDEXORDER(), DBF_SEEK(), DBF_SELECT(), DBF_SKIP(), DBF_USED(), FIELD_COUNT(), FIELD_LOOKUP()