QMIndices()

 Top  Previous  Next

 

The QMIndices() function retrieves information about alternate key indices. It is analogous to the QMBasic INDICES() function.

 

The function arguments are:

 

Fnois the file number returned by a previous use of QMOpen().

 

Index.Nameis the name of the index to be queried. If given as a null string, a list of all index names is returned.

 

 

The QMIndices() function has two modes of operation. If Index.Name is a null string, the function returns a field mark delimited list of index names for the given file. This is equivalent to use of the QMBasic INDICES() function with one argument.

 

If Index.Name is not a null string, details for the named index are returned in the same form as for the QMBasic INDICES() function with two arguments.

 

The examples below retrieve a list of index names for the file opened as fClients.

 

 

hmtoggle_plus1C

char * QMIndices(int Fno, char * Index.Name)

IndexNames = QMIndices(fClients, "");

...processing...

QMFree(IndexNames);

 

The returned pointer references a dynamically allocated memory area that must be released using QMFree() when no longer needed.

 

hmtoggle_plus1VB.Net

QMIndices(ByVal Fno as Integer, ByVal Index.Name as String) as String

IndexNames = QMIndices(fClients, "")

 

hmtoggle_plus1QMBasic Class Module

Indices(Fno, Index.Name)

IndexNames = session->Indices(fClients, "")

 

hmtoggle_plus1Java

String Indices(int Fno, String Index.Name)

IndexNames = qm.Indices(fClients, "");

 

hmtoggle_plus1Python

Indices(Fno, Index.Name)

IndexNames = qm.Indices(fClients, "")