FIELD NAME()

From Recital Documentation Wiki
Jump to: navigation, search

PURPOSE

Return a field name


SYNONYM

api_field_name()


SYNOPSIS

#include "dbapi.h"
 
char	*FIELD_NAME(fldno)
 
<input parameters>
int	fldno;		/* A field number			*/
 
<output parameters>
none


DESCRIPTION

The FIELD_NAME() function will return the name of the field specified by the field number.

The field name is returned as an upper case character string, unless the field number is out of range in which case a NULL value is returned.


EXAMPLE

The following example will return the field name for the specified number.

#include "dbapi.h"
 
dbapi_field_name()
{
    int	fldnum;
    char	*fldname;
 
    if (_parinfo(1) == API_NTYPE) {
       fldnum =  _parni(1);
       if (fldnum > FIELD_COUNT() || fldnum <= 0) {
       _retc("Field number out of range.");
       } else {
       fldname = FIELD_NAME(_parni(1));
       }
    } else {
       strcpy(fldname, "");
    }
 
    _retc( fldname );
}


SEE ALSO

BLOB_READ(), BLOB_RECLAIM(), BLOB_SIZE(), BLOB_UPDATE(), BLOB_WRITE(), DBF_FETCH(), DBF_GATHER(), DBF_RECBUFFER(), DBF_SCATTER(), DBF_SEEK(), FIELD_COUNT(), FIELD_LOOKUP(), FIELD_UPDATE(), FIELD_VALUE(), MEMO_MLINE(), MEMO_MLCOUNT(), MEMO_READ(), MEMO_RECLAIM(), MEMO_SIZE(), MEMO_UPDATE(), MEMO_WRITE()