Product Documentation

FairCom ISAM for C

Previous Topic

Next Topic


Extended index file creation.

Short Name



Extended Low-Level index file function


COUNT CreateIndexFileXtd(FILNO keyno, pTEXT filnam,

COUNT keylen, COUNT keytyp, COUNT keydup, COUNT nomemb,

UCOUNT xtdsiz, COUNT filmod, LONG permmask,

pTEXT groupid, pTEXT fileword)


In V12 the file number typedef was formally changed from COUNT, a two-byte value to FILNO, a four-byte value. Refer to this link for compatibility details. Four Byte File Numbering

CreateIndexFileXtd() is a variation of CreateIndexFile() permitting use of the FairCom Server’s security system. Please read the description of CreateIndexFile() before proceeding, since only the extended features are described here.

permmask is the permission mask assigned to this data file. It is formed by OR-ing the appropriate permission constants.

groupid is a pointer to a buffer containing the group id assigned to this file. The group id must be valid for the user that is creating the file. If groupid is null, the file is assigned to the user’s default group.

fileword is an optional file password. If fileword is null, no password is stored for this file. If one is established, every user will need to use the password to be able to open the file.

For more information on permission masks, group IDs, and file passwords, refer to Security and Encryption (File Security and Encryption, /doc/ctreeplus/FileSecurityandEncryption.htm).


The following error code may be seen in addition to those for CreateIndexFile():


Symbolic Constant




This user does not belong to the group groupid.

See FairCom DB Error Codes for a complete listing of valid FairCom DB error values.