View source for DBF INDEXKEY()

==PURPOSE==
Return the index key expression


==SYNONYM==
api_dbf_indexkey()


==SYNOPSIS==
<code lang="c">
#include "dbapi.h"

char	*DBF_INDEXKEY(order)

<input parameters>
int	order;		/* Index order		*/

<output parameters>
none
</code>


==DESCRIPTION==
The DBF_INDEXKEY() function will return the index key expression 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.


==EXAMPLE==
The following example returns the index key expression for the master index.

<code lang="c">
#include "dbapi.h"

dbapi_dbf_indexkey()
{
    char	*indexkey;
    
    indexkey = DBF_INDEXKEY( DBF_INDEXORDER());
    
    _retc( indexkey );
}
</code>


==SEE ALSO==
[[COMMAND()]], [[DBF_ALIAS()]], [[DBF_DBF()]], [[DBF_DELETED()]], [[DBF_FETCH()]], [[DBF_FILTER()]], [[DBF_FMT()]], [[DBF_INDEXORDER()]], [[DBF_NDX()]], [[DBF_SEEK()]], [[DBF_SELECT()]], [[DBF_SKIP()]], [[FIELD_COUNT()]], [[FIELD_LOOKUP()]]

[[Category:Documentation]]
[[Category:SDK]]