Function Name Cross Reference

Each FairCom DB function has two names: the full name and the abbreviated name. Full names are used throughout this manual, and describe the action the function performs. The abbreviated name is generally shorter and more cryptic. You will see it if you examine the FairCom DB source code. Prior versions of the c‑tree File Handler used the abbreviated names. If you have a program that worked with older versions of c‑tree, you will not have to change the function calls to the full names. Also included in the table is the function’s API group and a table of API groups.

 

Four Byte File Numbering TypeDef Change

FairCom V12 and later servers support opening more than 32,767 files. This enhancement has been designed so no application changes should be required. Each individual database connection is still limited to a maximum of 32,767 files (preserving the original definition of data and index file numbers as two-byte signed values, using the COUNT data type). Internally, a new four byte typedef was introduced supporting up to 2 billion files. Note that there is a compile-time limit of 1,000,000 files to reduce the memory footprint of the c-tree database engine. If you need more than 1,000,000 open files, please contact FairCom.

However, if opening many files, consider the possibility of using multiple FairCom DB engines to host the files, rather than having one FairCom DB engine hosting all the files. This is recommended as files compete for resources such as data and index cache, file system cache, operating system kernel memory, and transaction logs.

New FILNO typedef

The data type FILNO replaces COUNT in all API functions that specify a FairCom DB file number as input or output. When code is compiled with #define ctFeatMAXFILE32, FILNO evaluates to a 4-byte value. When ctFeatMAXFILE32 is off, FILNO evaluates to a 2-byte value as before. Likewise, the IFIL structure's dfilno and tfilno fields become 4-byte values when ctFeatMAXFILE32 is defined.

In addition, the global state variable isam_fil remains a two byte value (COUNT). isam_fil32 holds the four byte value (FILNO) in case of errors.

See Also

Millions of Open Files

 

Full Names

This table lists the functions alphabetically by the Full Name.

Full Name

Abbreviated Name

Function Type

Abort

TRANABT

Transaction Processing API

AbortXtd

TRANABTX

Transaction Processing API

AddCtResource

ADDRES

Utility API

AddKey

ADDKEY

Low-Level Data Manipulation API

AddRecord

ADDREC

ISAM Data Manipulation API

AddVRecord

ADDVREC

ISAM Data Manipulation API

AllocateBatch

ALCBAT

ISAM Data Manipulation - Batch API

AllocateSet

ALCSET

ISAM Data Manipulation - Sets API

AvailableFileNbr

AVLFILNUM

Utility API

Begin

TRANBEG

Transaction Processing API

BuildKey

frmkey

Low-Level Data Manipulation API

ChangeBatch

CHGBAT

ISAM Data Manipulation - Batch API

ChangeHistory

CHGHST

Transaction Processing API

ChangeISAMContext

CHGICON

ISAM Data Manipulation - Context API

ChangeSet

CHGSET

ISAM Data Manipulation - Sets API

CleanIndexXtd

CLNIDXX

Utility API

ClearSavePoint

SAVPCLR

Transaction Processing API

ClearTranError

TRANCLR

Transaction Processing API

CloseCtFile

CLSFIL

Low-Level Data Manipulation API

CloseIFile

CLIFIL

Initialization API - ISAM

CloseISAM

CLISAM

Initialization API - ISAM

CloseISAMContext

CLSICON

ISAM Data Manipulation - Context API

CloseRFile

CLRFIL

Initialization API - ISAM

Commit

TRANEND

Transaction Processing API

CompactIFile

CMPIFIL

Utility API

CompactIFileXtd

CMPIFILX

Utility API

cpybuf

cpybuf

Miscellaneous Functions

CreateDataFile

CREDAT

Low-Level Data Definition API

CreateDataFileXtd

CREDATX

Low-Level Data Definition API

CreateDataFileXtd8

CREDATX8

Low-Level Data Definition API

CreateIFile

CREIFIL

ISAM Data Definition API

CreateIFileXtd

CREIFILX

ISAM Data Definition API

CreateIFileXtd8

CREIFILX8

ISAM Data Definition API

CreateIndexFile

CREIDX

Low-Level Data Definition API

CreateIndexFileXtd

CREIDXX

Low-Level Data Definition API

CreateIndexFileXtd8

CREIDXX8

Low-Level Data Definition API

CreateIndexMember

CREMEM

Low-Level Data Definition API

CreateISAM

CREISAM

ISAM Data Definition API

CreateISAMXtd

CREISAMX

ISAM Data Definition API

ctFILELIST

ctFILELIST

Utility API

ctGETHGH

ctGETHGH

Low-Level Data Manipulation API

ctMBprefix

ctMBprefix

Utility API

CtreeAsynchronous

CTASYNC

Utility API

CtreeCheckPoint

CTCHKPNT

Transaction Processing API

CtreeFlushFile

CTFLUSH

Utility API

CtreeFlushFileXtd

CTFLUSHX

Utility API

ctSETHGH

ctSETHGH

Low-level Data Manipulation API

ctStatusLogWrite

ctStatusLogWrite

Server DLL (server side)

ctThrdAttach

ctThrdAttach

Initialization API - ctThrd API

ctThrdBlockCls

ctThrdBlockCls

Initialization API - ctThrd API

ctThrdBlockGet

ctThrdBlockGet

Initialization API - ctThrd API

ctThrdBlockInit

ctThrdBlockInit

Initialization API - ctThrd API

ctThrdBlockRel

ctThrdBlockRel

Initialization API - ctThrd API

ctThrdBlockWait

ctThrdBlockWait

Initialization API - ctThrd API

ctThrdCreate

ctThrdCreate

Initialization API - ctThrd API

ctThrdData

ctThrdData

Initialization API - ctThrd API

ctThrdDataSet

ctThrdDataSet

Initialization API - ctThrd API

ctThrdDetach

ctThrdDetach

Initialization API - ctThrd API

ctThrdExit

ctThrdExit

Initialization API - ctThrd API

ctThrdHandle

ctThrdHandle

Initialization API - ctThrd API

ctThrdInit

ctThrdInit

Initialization API - ctThrd API

ctThrdLIFOWrite

ctThrdLIFOWrite

Initialization API - ctThrd API

ctThrdMutexCls

ctThrdMutexCls

Initialization API - ctThrd API

ctThrdMutexGet

ctThrdMutexGet

Initialization API - ctThrd API

ctThrdMutexInit

ctThrdMutexInit

Initialization API - ctThrd API

ctThrdMutexRel

ctThrdMutexRel

Initialization API - ctThrd API

ctThrdMutexTry

ctThrdMutexTry

Initialization API - ctThrd API

ctThrdQueueClose

ctThrdQueueClose

Initialization API - ctThrd API

ctThrdQueueCount

ctThrdQueueCount

Initialization API - ctThrd API

ctThrdQueueMlen

ctThrdQueueMlen

Initialization API - ctThrd API

ctThrdQueueOpen

ctThrdQueueOpen

Initialization API - ctThrd API

ctThrdQueueRead

ctThrdQueueRead

Initialization API - ctThrd API

ctThrdQueueReadDirect

ctThrdQueueReadDirect

Initialization API - ctThrd API

ctThrdQueueWrite

ctThrdQueueWrite

Initialization API - ctThrd API

ctThrdQueueWriteDirect

ctThrdQueueWriteDirect

Initialization API - ctThrd API

ctThrdSemapCls

ctThrdSemapCls

Initialization API - ctThrd API

ctThrdSemapGet

ctThrdSemapGet

Initialization API - ctThrd API

ctThrdSemapInit

ctThrdSemapInit

Initialization API - ctThrd API

ctThrdSemapRel

ctThrdSemapRel

Initialization API - ctThrd API

ctThrdSemapTry

ctThrdSemapTry

Initialization API - ctThrd API

ctThrdSleep

ctThrdSleep

Initialization API - ctThrd API

ctThrdTerm

ctThrdTerm

Initialization API - ctThrd API

ctu16tou8

ctu16tou8

Utility API

ctu8tou16

ctu8tou16

Utility API

ctVerifyFile

ctVerifyFile

Verifies integrity of a file

ctVERIFYidx

ctVERIFYidx

Verifies integrity of a file

CurrentFileOffset

GETCURP

ISAM Data Manipulation API

CurrentISAMKey

GETCURK

ISAM Data Manipulation API

CurrentLowLevelKey

GETCURKL

Low-Level Data Manipulation API

DeleteCtFile

DELFIL

Low-Level Data Definition API

DeleteCtResource

DELRES

Utility API

DeleteIFile

DELIFIL

ISAM Data Definition API

DeleteKey

DELCHK

Low-Level Data Manipulation API

DeleteKeyBlind

DELBLD

Low-Level Data Manipulation API

DeleteRecord

DELREC

ISAM Data Manipulation API

DeleteRFile

DELRFIL

ISAM Data Definition API

DeleteVRecord

DELVREC

ISAM Data Manipulation API

DoBatch

BATSET

ISAM Data Manipulation - Batch API

DropIndex

ctDROPIDX

ISAM Data Definition API

EnableCtResource

ENARES

Utility API

EstimateKeySpan

ESTKEY

Low-Level Data Manipulation API

FirstInSet

FRSSET

ISAM Data Manipulation - Sets API

FirstInVSet

FRSVSET

ISAM Data Manipulation - Sets API

FirstKey

FRSKEY

Low-Level Data Manipulation API

FirstRecord

FRSREC

ISAM Data Manipulation API

FirstVRecord

FRSVREC

ISAM Data Manipulation API

FreeBatch

FREBAT

ISAM Data Manipulation - Batch API

FreeBatchNbr

FREBATN

ISAM Data Manipulation - Batch API

FreeHistory

FREHST

Transaction Processing API

FreeHistoryNbr

FREHSTN

Transaction Processing API

FreeSet

FRESET

ISAM Data Manipulation - Sets API

FreeSetNbr

FRESETN

ISAM Data Manipulation - Sets API

GetAltSequence

GETALTSEQ

Low-Level Data Definition API

GetConditionalIndex

GETCIDX

ISAM Data Definition API

GetCtFileInfo

GETFIL

Low-Level Data Definition API

GetCtResource

GETRES

Initialization API - Instance Control

GetCtreePointer

GETCTREE

Utility API

GetCtTempFileName

TMPNAME

Utility API

GetDODA

GETDODA

ISAM Data Definition API

GetGTEKey

GTEKEY

Low-Level Data Manipulation API

GetGTERecord

GTEREC

ISAM Data Manipulation API

GetGTEVRecord

GTEVREC

ISAM Data Manipulation API

GetGTKey

GTKEY

Low-level Data Manipulation API

GetGTRecord

GTREC

ISAM Data Manipulation API

GetGTVRecord

GTVREC

ISAM Data Manipulation API

GetIFile

GETIFIL

ISAM Data Definition API

GetKey

EQLKEY

Low-Level Data Manipulation API

GetLTEKey

LTEKEY

Low-Level Data Manipulation API

GetLTERecord

LTEREC

ISAM Data Manipulation API

GetLTEVRecord

LTEVREC

ISAM Data Manipulation API

GetLTKey

LTKEY

Low-Level Data Manipulation API

GetLTRecord

LTREC

ISAM Data Manipulation API

GetLTVRecord

LTVREC

ISAM Data Manipulation API

GetORDKey

ORDKEY

Low-Level Data Manipulation API

GetRecord

EQLREC

ISAM Data Manipulation API

GetSerialNbr

SERIALNUM

Utility API

GetServerInfo

GetServerInfo

Low-Level Data Definition API

GetServerInfoXtd

GetServerInfoXtd

Low-Level Data Definition API

GetSuperFileNames

GETMNAME

Low-Level Data Definition API

GetSymbolicNames

GETNAM

Low-Level Data Definition API

GetVRecord

EQLVREC

ISAM Data Manipulation API

GetXtdCreateBlock

GETXCREBLK

Utility API

GetXtdKeySegmentDef

GETKSEGDEF

ISAM Data Definition API

InitCTree

INTREE

Initialization API - Low-level

InitCTreeXtd

INTREEX

Initialization API - Low-level

InitISAM

INTISAM

Initialization API - ISAM

InitISAMXtd

INTISAMX

Initialization API - ISAM

IOPERFORMANCE

IOPERFORMANCE

Server Administration API

IOPERFORMANCEX

IOPERFORMANCEX

Server Administration API

KeyAtPercentile

FRCKEY

Low-Level Data Manipulation API

LastInSet

LSTSET

ISAM Data Manipulation - Sets API

LastInVSet

LSTVSET

ISAM Data Manipulation - Sets API

LastKey

LSTKEY

Low-Level Data Manipulation API

LastRecord

LSTREC

ISAM Data Manipulation API

LastVRecord

LSTVREC

ISAM Data Manipulation API

LoadKey

LOADKEY

Low-Level Data Manipulation API

LockCtData

LOKREC

Low-Level Data Manipulation API

LockDump

ctLOKDMP

Server Administration API

LockISAM

LKISAM

ISAM Data Manipulation API

NbrOfKeyEntries

IDXENT

Low-Level Data Manipulation API

NbrOfKeysInRange

RNGENT

Low-Level Data Manipulation API

NbrOfRecords

DATENT

ISAM Data Manipulation API

NewData

NEWREC

Low-Level Data Manipulation API

NewVData

NEWVREC

Low-Level Data Manipulation API

NextCtree

NXTCTREE

Initialization API - Instance Control

NextInSet

NXTSET

ISAM Data Manipulation - Sets API

NextInVSet

NXTVSET

ISAM Data Manipulation - Sets API

NextKey

NXTKEY

Low-Level Data Manipulation API

NextRecord

NXTREC

ISAM Data Manipulation API

NextVRecord

NXTVREC

ISAM Data Manipulation API

OpenCtFile

OPNFIL

Initialization API - ISAM

OpenCtFileXtd

OPNFILX

Initialization API - ISAM

OpenFileWithResource

OPNRFIL

Initialization API - ISAM

OpenFileWithResourceXtd

OPNRFILX

Initialization API - ISAM

OpenIFile

OPNIFIL

Initialization API - ISAM

OpenIFileXtd

OPNIFILX

Initialization API - ISAM

OpenISAM

OPNISAM

Initialization API - ISAM

OpenISAMContext

OPNICON

Initialization API - ISAM

OpenISAMXtd

OPNISAMX

Initialization API - ISAM

PartitionAdmin

PTADMIN

Utility API

Perform

PERFORM

Server Administration API

PermIIndex

PRMIIDX

ISAM Data Definition API

PermIIndex8

PRMIIDX8

ISAM Data Definition API

PositionSet

MIDSET

ISAM Data Manipulation - Sets API

PositionVSet

MIDVSET

ISAM Data Manipulation - Sets API

PreviousInSet

PRVSET

ISAM Data Manipulation API

PreviousInVSet

PRVVSET

ISAM Data Manipulation API

PreviousKey

PRVKEY

Low-level Data Manipulation API

PreviousRecord

PRVREC

ISAM Data Manipulation API

PreviousVRecord

PRVVREC

ISAM Data Manipulation API

PutDODA

PUTDODA

ISAM Data Definition API

PutIFile

PUTIFIL

ISAM Data Definition API

PutIFileXtd

PUTIFILX

ISAM Data Definition API

PutIFileXtd8

PUTIFILX8

ISAM Data Definition API

PutXtdKeySegmentDef

PUTKSEGDEF

ISAM Data Definition

ReadData

REDREC

Low-level Data Manipulation API

ReadIsamData

REDIREC

ISAM Data Manipulation API

ReadIsamVData

REDIVREC

ISAM Data Manipulation API

ReadVData

RDVREC

Low-Level Data Manipulation API

RebuildIFile

RBLIFIL

ISAM Data Definition API

RebuildIFileXtd

RBLIFILX

ISAM Data Definition API

RebuildIFileXtd8

RBLIFILX8

ISAM Data Definition API

RebuildIIndex

RBLIIDX

ISAM Data Definition API

RegisterCtree

REGCTREE

Initialization API - Instance Control

ReleaseData

RETREC

Low-Level Data Manipulation API

ReleaseVData

RETVREC

Low-Level Data Manipulation API

RenameFile

ctRENFIL

Low-Level Data Definition API

RenameIFile

RENIFIL

ISAM Data Definition API

RenameIFileXtd

RENIFILX

ISAM Data Definition API

ReReadRecord

RRDREC

ISAM Data Manipulation API

ReReadVRecord

REDVREC

ISAM Data Manipulation API

ResetRecord

UPDCURI

ISAM Data Manipulation API

RestoreSavePoint

TRANRST

Transaction Processing API

ReWriteRecord

RWTREC

ISAM Data Manipulation API

ReWriteVRecord

RWTVREC

ISAM Data Manipulation API

SA_FILES

SA_FILES

Server Administration API

SA_GROUP

SA_GROUP

Server Administration API

SA_LOGOF

SA_LOGOF

Server Administration API

SA_LOGON

SA_LOGON

Server Administration API

SA_USERS

SA_USERS

Server Administration API

Security

SECURITY

Server Administration API

SetAlternateSequence

SETALTSEQ

Low-Level Data Definition API

SetCallbackOnRebuild

SETCBRBL

Utility API

SetDataFilter

SETFLTR

Low-Level Data Manipulation API

SetEncryption

ctSETENCRYPT

Utility API

SetFileSegments

ctSETSEG

Low-Level Data Definition API

SETLOGPATH

SETLOGPATH

Transaction Processing API

SetNodeName

SETNODE

Server Administration API

SetOperationState

SETOPS

Utility API

SetRecord

SETCURI

ISAM Data Manipulation API

SetSavePoint

TRANSAV

Transaction Processing API

SetVariableBytes

SETVARBYTS

Low-Level Data Definition API

StopServer

STPSRV

Server Administration API

StopServerXtd

STPSRVX

Server Administration API

StopUser

STPUSR

Server Administration API

StopUserAsync

STPUSRA

Server Administration API

SuperfilePrepassXtd

CTSBLDX

Utility API

SwitchCtree

SWTCTREE

Initialization API - Instance Control

SystemConfiguration

SYSCFG

Utility API

SystemLog

SYSLOG

Server Administration API

SystemMonitor

SYSMON

Utility API

TempIIndexXtd

TMPIIDXX

ISAM Data Definition API

TempIIndexXtd8

TMPIIDXX8

ISAM Data Definition API

TestFileNbr

TSTFILNUM

Utility API

TestHugeFile

TESTHUGE

Utility API

TransformKey

TFRMKEY

Low-Level Data Manipulation API

TranformSegment

cttseg

Transaction Processing API

TranformXtdSegment

XFMKSEGDEF

ISAM Data Definition API

TransactionHistory

CTHIST

ISAM Data Manipulation API

UnRegisterCtree

UNRCTREE

Initialization API - Instance Control

UpdateConditionalIndex

UPDCIDX

ISAM Data Definition API

UpdateCtResource

UPDRES

Utility API

UpdateFileMode

PUTFIL

Low-Level Data Definition API

UpdateHeader

PUTHDR

Low-Level Data Definition API

VDataLength

GTVLEN

Low-Level Data Manipulation API

VRecordLength

GETVLEN

ISAM Data Manipulation API

vtclose

vtclose

Utility API

WhichCtree

WCHCTREE

Initialization API - Instance Control

WriteData

WRTREC

Low-Level Data Manipulation API

WriteVData

WRTVREC

Low-Level Data Manipulation API

 

Abbreviated (short) Names

This table lists the functions alphabetically by the Abbreviated Name.

Abbreviated Name

Full Name

Function Type

ADDKEY

AddKey

Low-Level Data Manipulation API

ADDREC

AddRecord

ISAM Data Manipulation API

ADDRES

AddCtResource

Utility API

ADDVREC

AddVRecord

ISAM Data Manipulation API

ALCBAT

AllocateBatch

ISAM Data Manipulation - Batch API

ALCSET

AllocateSet

ISAM Data Manipulation - Sets API

AVLFILNUM

AvailableFileNbr

Utility API

BATSET

DoBatch

ISAM Data Manipulation - Batch API

CHGBAT

ChangeBatch

ISAM Data Manipulation - Batch API

CHGHST

ChangeHistory

Transaction Processing API

CHGICON

ChangeISAMContext

ISAM Data Manipulation - Context API

CHGSET

ChangeSet

ISAM Data Manipulation - Sets API

CLIFIL

CloseIFile

Initialization API - ISAM

CLISAM

CloseISAM

Initialization API - ISAM

CLNIDXX

CleanIndexXtd

Utility API

CLRFIL

CloseRFile

Initialization API - ISAM

CLSFIL

CloseCtFile

Initialization API - Low-level

CLSICON

CloseISAMContext

ISAM Data Manipulation - Context API

CMPIFIL

CompactIFile

ISAM Data Definition API

CMPIFILX

CompactIFileXtd

ISAM Data Definition API

cpybuf

cpybuf

Utility API

CREDAT

CreateDataFile

Low-Level Data Definition API

CREDATX

CreateDataFileXtd

Low-Level Data Definition API

CREDATX8

CreateDataFileXtd8

Low-Level Data Definition API

CREIDX

CreateIndexFile

Low-Level Data Definition API

CREIDXX

CreateIndexFileXtd

Low-Level Data Definition API

CREIDXX8

CreateIndexFileXtd8

Low-Level Data Definition API

CREIFIL

CreateIFile

ISAM Data Definition API

CREIFILX

CreateIFileXtd

ISAM Data Definition API

CREIFILX8

CreateIFileXtd8

ISAM Data Definition API

CREISAM

CreateISAM

ISAM Data Definition API

CREISAMX

CreateISAMXtd

ISAM Data Definition API

CREMEM

CreateIndexMember

Low-Level Data Definition API

CTASYNC

CtreeAsynchronous

Utility API

CTCHKPNT

CtreeCheckPoint

Transaction Processing API

ctDROPIDX

DropIndex

ISAM Data Definition API

ctFILELIST

ctFILELIST

Utility API

CTFLUSH

CtreeFlushFile

Utility API

CTFLUSHX

CtreeFlushFileXtd

Utility API

ctGETHGH

ctGETHGH

Low-Level Data Manipulation API

CTHIST

TransactionHistory

Transaction Processing API

ctLOKDMP

LockDump

Server Administration API

ctMBprefix

ctMBprefix

Utility API

ctRENFIL

RenameFile

Low-Level Data Definition API

CTSBLDX

SuperfilePrePassXtd

Utility API

ctSETENCRYPT

SetEncryption

Utility API

ctSETHGH

ctSETHGH

Low-Level Data Manipulation API

ctSETSEG

SetFileSegments

Low-Level Data Definition API

ctStatusLogWrite

ctStatusLogWrite

Server DLL (server side)

ctThrdAttach

ctThrdAttach

Initialization API - ctThrd API

ctThrdBlockCls

ctThrdBlockCls

Initialization API - ctThrd API

ctThrdBlockGet

ctThrdBlockGet

Initialization API - ctThrd API

ctThrdBlockInit

ctThrdBlockInit

Initialization API - ctThrd API

ctThrdBlockRel

ctThrdBlockRel

Initialization API - ctThrd API

ctThrdBlockWait

ctThrdBlockWait

Initialization API - ctThrd API

ctThrdCreate

ctThrdCreate

Initialization API - ctThrd API

ctThrdData

ctThrdData

Initialization API - ctThrd API

ctThrdDataSet

ctThrdDataSet

Initialization API - ctThrd API

ctThrdDetach

ctThrdDetach

Initialization API - ctThrd API

ctThrdExit

ctThrdExit

Initialization API - ctThrd API

ctThrdHandle

ctThrdHandle

Initialization API - ctThrd API

ctThrdInit

ctThrdInit

Initialization API - ctThrd API

ctThrdLIFOWrite

ctThrdLIFOWrite

Initialization API - ctThrd API

ctThrdMutexCls

ctThrdMutexCls

Initialization API - ctThrd API

ctThrdMutexGet

ctThrdMutexGet

Initialization API - ctThrd API

ctThrdMutexInit

ctThrdMutexInit

Initialization API - ctThrd API

ctThrdMutexRel

ctThrdMutexRel

Initialization API - ctThrd API

ctThrdMutexTry

ctThrdMutexTry

Initialization API - ctThrd API

ctThrdQueueClose

ctThrdQueueClose

Initialization API - ctThrd API

ctThrdQueueCount

ctThrdQueueCount

Initialization API - ctThrd API

ctThrdQueueMlen

ctThrdQueueMlen

Initialization API - ctThrd API

ctThrdQueueOpen

ctThrdQueueOpen

Initialization API - ctThrd API

ctThrdQueueRead

ctThrdQueueRead

Initialization API - ctThrd API

ctThrdQueueReadDirect

ctThrdQueueReadDirect

Initialization API - ctThrd API

ctThrdQueueWrite

ctThrdQueueWrite

Initialization API - ctThrd API

ctThrdQueueWriteDirect

ctThrdQueueWriteDirect

Initialization API - ctThrd API

ctThrdSemapCls

ctThrdSemapCls

Initialization API - ctThrd API

ctThrdSemapGet

ctThrdSemapGet

Initialization API - ctThrd API

ctThrdSemapInit

ctThrdSemapInit

Initialization API - ctThrd API

ctThrdSemapRel

ctThrdSemapRel

Initialization API - ctThrd API

ctThrdSemapTry

ctThrdSemapTry

Initialization API - ctThrd API

ctThrdSleep

ctThrdSleep

Initialization API - ctThrd API

ctThrdTerm

ctThrdTerm

Initialization API - ctThrd API

cttseg

TransformSegment

Low-Level Data Manipulation API

ctu16tou8

ctu16tou8

Utility API

ctu8tou16

ctu8tou16

Utility API

ctVerifyFile

ctVerifyFile

Verifies integrity of a file

ctVERIFYidx

ctVERIFYidx

Verifies integrity of a file

DATENT

NbrOfRecords

ISAM Data Manipulation API

DELBLD

DeleteKeyBlind

Low-Level Data Manipulation API

DELCHK

DeleteKey

Low-Level Data Manipulation API

DELFIL

DeleteCtFile

Low-Level Data Definition API

DELIFIL

DeleteIFile

ISAM Data Definition API

DELREC

DeleteRecord

ISAM Data Manipulation API

DELRES

DeleteCtResource

Utility API

DELRFIL

DeleteRFile

ISAM Data Definition API

DELVREC

DeleteVRecord

ISAM Data Manipulation API

ENARES

EnableCtResource

Utility API

EQLKEY

GetKey

Low-Level Data Manipulation API

EQLREC

GetRecord

ISAM Data Manipulation API

EQLVREC

GetVRecord

Low-Level Data Manipulation API

ESTKEY

EstimateKeySpan

Low-Level Data Manipulation API

FRCKEY

KeyAtPercentile

Low-Level Data Manipulation API

FREBAT

FreeBatch

ISAM Data Manipulation - Batch API

FREBATN

FreeBatchNbr

ISAM Data Manipulation - Batch API

FREHST

FreeHistory

Transaction Processing API

FREHSTN

FreeHistoryNbr

Transaction Processing API

FRESET

FreeSet

ISAM Data Manipulation - Sets API

FRESETN

FreeSetNbr

ISAM Data Manipulation - Sets API

frmkey

BuildKey

Low-Level Data Manipulation API

FRSKEY

FirstKey

Low-Level Data Manipulation API

FRSREC

FirstRecord

ISAM Data Manipulation API

FRSSET

FirstInSet

ISAM Data Manipulation - Sets API

FRSVREC

FirstVRecord

ISAM Data Manipulation API

FRSVSET

FirstInVSet

ISAM Data Manipulation - Sets API

GETALTSEQ

GetAlternateSequence

Low-Level Data Definition API

GETCIDX

GetConditionalIndex

ISAM Data Definition API

GETCTREE

GetCtreePointer

Initialization API - Instance Control

GETCURK

CurrentISAMKey

ISAM Data Manipulation API

GETCURKL

CurrentLowLevelKey

Low-Level Data Manipulation API

GETCURP

CurrentFileOffset

ISAM Data Manipulation API

GETDODA

GetDODA

ISAM Data Definition API

GETFIL

GetCtFileInfo

Low-level Data Definition API

GETIFIL

GetIFile

ISAM Data Definition API

GETKSEGDEF

GetXtdKeySegmentDef

ISAM Data Definition API

GETMNAME

GetSuperFileNames

Low-Level Data Definition API

GETNAM

GetSymbolicNames

ISAM Data Manipulation API

GETRES

GetCtResource

Utility API

GetServerInfo

GetServerInfo

Low-Level Data Definition API

GetServerInfoXtd

GetServerInfoXtd

Low-Level Data Definition API

GETVLEN

VRecordLength

ISAM Data Manipulation API

GETXCREBLK

GetXtdCreateBlock

Utility API

GTEKEY

GetGTEKey

Low-Level Data Manipulation API

GTEREC

GetGTERecord

ISAM Data Manipulation API

GTEVREC

GetGTEVRecord

ISAM Data Manipulation API

GTKEY

GetGTKey

Low-Level Data Manipulation API

GTREC

GetGTRecord

ISAM Data Manipulation API

GTVLEN

VDataLength

Low-Level Data Manipulation API

GTVREC

GetGTVRecord

ISAM Data Manipulation API

IDXENT

NbrOfKeyEntries

Low-Level Data Manipulation API

INTISAM

InitISAM

Initialization API - ISAM

INTISAMX

InitISAMXtd

Initialization API - ISAM

INTREE

InitCTree

Initialization API - Low-level

INTREEX

InitCTreeXtd

Initialization API - Low-level

IOPERFORMANCE

IOPERFORMANCE

Server Administration API

IOPERFORMANCEX

IOPERFORMANCEX

Server Administration API

LKISAM

LockISAM

ISAM Data Manipulation API

LOADKEY

LoadKey

Low-Level Data Manipulation API

LOKREC

LockCtData

Low-Level Data Manipulation API

LSTKEY

LastKey

Low-Level Data Manipulation API

LSTREC

LastRecord

ISAM Data Manipulation API

LSTSET

LastInSet

ISAM Data Manipulation - Sets API

LSTVREC

LastVRecord

ISAM Data Manipulation API

LSTVSET

LastInVSet

ISAM Data Manipulation - Sets API

LTEKEY

GetLTEKey

Low-Level Data Manipulation API

LTEREC

GetLTERecord

ISAM Data Manipulation API

LTEVREC

GetLTEVRecord

ISAM Data Manipulation API

LTKEY

GetLTKey

Low-Level Data Manipulation API

LTREC

GetLTRecord

ISAM Data Manipulation API

LTVREC

GetLTVRecord

ISAM Data Manipulation API

MIDSET

PositionSet

ISAM Data Manipulation - Sets API

MIDVSET

PositionVSet

ISAM Data Manipulation - Sets API

NEWREC

NewData

Low-Level Data Manipulation API

NEWVREC

NewVData

Low-Level Data Manipulation API

NXTCTREE

NextCtree

Initialization API - Instance Control

NXTKEY

NextKey

Low-Level Data Manipulation API

NXTREC

NextRecord

ISAM Data Manipulation API

NXTSET

NextInSet

ISAM Data Manipulation - Sets API

NXTVREC

NextVRecord

ISAM Data Manipulation API

NXTVSET

NextInVSet

ISAM Data Manipulation - Sets API

OPNFIL

OpenCtFile

Initialization API - Low-Level

OPNFILX

OpenCtFileXtd

Initialization API - Low-Level

OPNICON

OpenISAMContext

ISAM Data Manipulation - Context API

OPNIFIL

OpenIFile

Initialization API - ISAM

OPNIFILX

OpenIFileXtd

Initialization API - ISAM

OPNISAM

OpenISAM

Initialization API - ISAM

OPNISAMX

OpenISAMXtd

Initialization API - ISAM

OPNRFIL

OpenFileWithResource

Initialization API - ISAM

OPNRFILX

OpenFileWithResourceXtd

Initialization API - ISAM

ORDKEY

GetORDKey

Low-Level Data Manipulation API

PERFORM

Perform

Server Administration API

PRMIIDX

PermIIndex

ISAM Data Definition API

PRMIIDX8

PermIIndex8

ISAM Data Definition API

PRVKEY

PreviousKey

Low-Level Data Manipulation API

PRVREC

PreviousRecord

ISAM Data Manipulation API

PRVSET

PreviousInSet

ISAM Data Manipulation - Sets API

PRVVREC

PreviousVRecord

ISAM Data Manipulation API

PRVVSET

PreviousInVSet

ISAM Data Manipulation - Sets API

PTADMIN

PartitionAdmin

Utility API

PUTDODA

PutDoda

ISAM Data Definition API

PUTFIL

UpdateFileMode

Low-Level Data Definition API

PUTHDR

UpdateHeader

Low-Level Data Definition API

PUTIFIL

PutIFile

ISAM Data Definition API

PUTIFILX

PutIFileXtd

ISAM Data Definition API

PUTIFILX8

PutIFileXtd8

ISAM Data Definition API

PUTKSEGDEF

PutXtdKeySegmentDef

ISAM Data Definition

RBLIFIL

RebuildIFile

ISAM Data Definition API

RBLIFILX

RebuildIFileXtd

ISAM Data Definition API

RBLIFILX8

RebuildIFileXtd8

ISAM Data Definition API

RBLIIDX

RebuildIIndex

ISAM Data Definition API

RDVREC

ReadVData

Low-Level Data Manipulation API

REDIREC

ReadIsamData

ISAM Data Manipulation API

REDIVREC

ReadIsamVData

ISAM Data Manipulation API

REDREC

ReadData

Low-Level Data Manipulation API

REDVREC

ReReadVRecord

ISAM Data Manipulation API

REGCTREE

RegisterCtree

Initialization API - Instance Control

RENIFIL

RenameIFile

ISAM Data Definition API

RENIFILX

RenameIFileXtd

ISAM Data Definition API

RETREC

ReleaseData

Low-Level Data Manipulation API

RETVREC

ReleaseVData

Low-Level Data Manipulation API

RNGENT

NbrOfKeysInRange

Low-Level Data Manipulation API

RRDREC

ReReadRecord

ISAM Data Manipulation API

RWTREC

ReWriteRecord

ISAM Data Manipulation API

RWTVREC

ReWriteVRecord

ISAM Data Manipulation API

SA_FILES

SA_FILES

Server Administration API

SA_GROUP

SA_GROUP

Server Administration API

SA_LOGOF

SA_LOGOF

Server Administration API

SA_LOGON

SA_LOGON

Server Administration API

SA_USERS

SA_USERS

Server Administration API

SAVPCLR

ClearSavePoint

Transaction Processing API

SECURITY

Security

Server Administration API

SERIALNUM

GetSerialNbr

Utility API

SETALTSEQ

SetAlternateSequence

Low-Level Data Definition API

SETCBRBL

SetCallbackOnRebuild

Utility API

SETCURI

SetRecord

ISAM Data Manipulation API

SETFLTR

SetDataFilter

Low-Level Data Manipulation API

SETLOGPATH

SETLOGPATH

Transaction Processing API

SETNODE

SetNodeName

Server Administration API

SETOPS

SetOperationState

Utility API

SETVARBYTS

SetVariableBytes

Low-Level Data Definition API

STPSRV

StopServer

Server Administration API

STPSRVX

StopServerXtd

Server Administration API

STPUSR

StopUser

Initialization API - ISAM

STPUSRA

StopUserAsync

Initialization API - ISAM

SWTCTREE

SwitchCtree

Initialization API - Instance Control

SYSCFG

SystemConfiguration

Utility API

SYSLOG

SystemLog

Server Administration API

SYSMON

SystemMonitor

Utility API

TESTHUGE

TestHugeFile

Utility API

TFRMKEY

TransformKey

ISAM Data Manipulation API

TMPIIDXX

TempIIndexXtd

ISAM Data Definition API

TMPIIDXX8

TempIIndexXtd8

ISAM Data Definition API

TMPNAME

GetCtTempFileName

Utility API

TRANABT

Abort

Transaction Processing API

TRANABTX

AbortXtd

Transaction Processing API

TRANBEG

Begin

Transaction Processing API

TRANCLR

ClearTranError

Transaction Processing API

TRANEND

Commit

Transaction Processing API

TRANRST

RestoreSavePoint

Transaction Processing API

TRANSAV

SetSavePoint

Transaction Processing API

TSTFILNUM

TestFileNbr

Utility API

UNRCTREE

UnRegisterCtree

Initialization API - Instance Control

UPDCIDX

UpdateConditionalIndex

ISAM Data Definition API

UPDCURI

ResetRecord

ISAM Data Manipulation API

UPDRES

UpdateCtResource

Utility API

vtclose

vtclose

Utility API

WCHCTREE

WhichCtree

Initialization API - Instance Control

WRTREC

WriteData

Low-Level Data Manipulation API

WRTVREC

WriteVData

Low-Level Data Manipulation API

XFMKSEGDEF

TranformXtdSegment

ISAM Data Definition API

 

Function API Listing

This section lists the FairCom DB Function API broken into functional groupings: Initialization, Definition, Manipulation, and Utility. Each of these groupings has sub-groups as described in the topics that follow.

 

Initialization API

The initialization API prepares the environment for FairCom DB operation. Included are the ctThrd, Instance Control, ISAM Initialization, and Low-Level Initialization APIs.

 

ctThrd API

The FairCom DB ctThrd API is a very thin overlay over the native threading API for each operating systems. Only systems without native threading use a FairCom DB proprietary threading API.

ctThrdAttach

ctThrdInit

ctThrdQueueRead

ctThrdBlockCls

ctThrdLIFOWrite

ctThrdQueueReadDirect

ctThrdBlockGet

ctThrdMutexCls

ctThrdQueueWrite

ctThrdBlockInit

ctThrdMutexGet

ctThrdQueueWriteDirect

ctThrdBlockRel

ctThrdMutexInit

ctThrdSemapCls

ctThrdBlockWait

ctThrdMutexRel

ctThrdSemapGet

ctThrdCreate

ctThrdMutexTry

ctThrdSemapInit

ctThrdData

ctThrdQueueClose

ctThrdSemapRel

ctThrdDataSet

ctThrdQueueCount

ctThrdSemapTry

ctThrdDetach

ctThrdQueueMlen

ctThrdSleep

ctThrdExit

ctThrdQueueOpen

ctThrdTerm

ctThrdHandle

 

 

 

Instance Control API

Similar to the thread API but used only with single-thread models, Instance Control allows and controls multiple FairCom DB instances within a single application.

GetCtreePointer

RegisterCtree

UnRegisterCtree

NextCtree

SwitchCtree

WhichCtree

 

ISAM Initialization API

Used to initialize the ISAM level operation of FairCom DB.

CloseIFile

InitISAMXtd

OpenIFileXtd

CloseISAM

OpenFileWithResource

OpenISAM

CloseRFile

OpenFileWithResourceXtd

OpenISAMXtd

InitISAM

OpenIFile

 

 

Low-Level Initialization API

Used to initialize the Low-Level FairCom DB environment.

CloseCtFile

InitCTreeXtd

OpenCtFileXtd

InitCTree

OpenCtFile

 

 

Data Definition API

Used to create and define tables and indexes. Divided into ISAM and Low-Level APIs.

 

ISAM Data Definition API

Used to create and define files for ISAM level use.

CompactIFile

GetDODA

RebuildIFile

CompactIFileXtd

GetIFile

RebuildIFileXtd

CreateIFile

GetXtdKeySegmentDef

RebuildIFileXtd8

CreateIFileXtd

PermIIndex

RebuildIIndex

CreateIFileXtd8

PermIIndex8

RenameIFile

CreateISAM

PutDODA

RenameIFileXtd

CreateISAMXtd

PutIFile

TempIIndexXtd

DeleteIFile

PutIFileXtd

TempIIndexXtd8

DeleteRFile

PutIFileXtd8

TranformXtdSegment

DropIndex

PutXtdKeySegmentDef

UpdateConditionalIndex

GetConditionalIndex

 

 

 

Low-Level Data Definition API

Used to create and define files for Low-Level use.

CreateDataFile

DeleteCtFile

RenameFile

CreateDataFileXtd

GetAlternateSequence

SetAlternateSequence

CreateDataFileXtd8

GetCtFileInfo

SetFileSegments

CreateIndexFile

GetServerInfo

SetVariableBytes

CreateIndexFileXtd

GetServerInfoXtd

UpdateFileMode

CreateIndexFileXtd8

GetSuperFileNames

UpdateHeader

CreateIndexMember

 

 

 

Data Manipulation API

Data manipulation functions are used to alter the contents of data and index files. This sections is divided into ISAM and Low-Level functions.

 

ISAM Data Manipulation API

ISAM Manipulation functions are divided into general, Batch, Context, and Set APIs.

AddRecord

GetLTEVRecord

PreviousVRecord

AddVRecord

GetLTRecord

ReadIsamData

CurrentFileOffset

GetLTVRecord

ReadIsamVData

CurrentISAMKey

GetRecord

ReReadRecord

DeleteRecord

GetSymbolicNames

ReReadVRecord

DeleteVRecord

LastRecord

ResetRecord

FirstRecord

LastVRecord

ReWriteRecord

FirstVRecord

LockISAM

ReWriteVRecord

GetGTERecord

NbrOfRecords

SetDataFilter

GetGTEVRecord

NextRecord

SetRecord

GetGTRecord

NextVRecord

TransformKey

GetGTVRecord

PreviousRecord

VRecordLength

GetLTERecord

 

 

 

Batch API

Manipulate batches of records in a single call.

AllocateBatch

DoBatch

FreeBatchNbr

ChangeBatch

FreeBatch

 

 

Context API

Maintain separate positions in a file.

ChangeISAMContext

CloseISAMContext

OpenISAMContext


Sets API

Work with a specified subset of a table’s records.

AllocateSet

FreeSetNbr

PositionSet

ChangeSet

LastInSet

PositionVSet

FirstInSet

LastInVSet

PreviousInSet

FirstInVSet

NextInSet

PreviousInVSet

FreeSet

NextInVSet

 

 

Low-Level Data Manipulation API

Manipulate data and index files at the low level.

AddKey

GetKey

NewData

BuildKey

GetLTEKey

NextKey

ctGETHGH

GetLTKey

PreviousKey

ctSETHGH

GetORDKey

ReadData

CurrentLowLevelKey

GetVRecord

ReadVData

DeleteKey

KeyAtPercentile

ReleaseData

DeleteKeyBlind

LastKey

ReleaseVData

EstimateKeySpan

LoadKey

TransformSegment

FirstKey

LockCtData

VDataLength

GetGTEKey

NbrOfKeyEntries

WriteData

GetGTKey

NbrOfKeysInRange

WriteVData

 

Utility Functions

The following functions provide capabilities that do not fit into the categories above. In addition to general utility functions, Server administration and Transaction Processing control functions are included here.

AddCtResource

ctu16tou8

SetEncryption

AvailableFileNbr

ctu8tou16

SetOperationState

CleanIndexXtd

DeleteCtResource

SuperfilePrePassXtd

cpybuf

EnableCtResource

SystemConfiguration

ctFILELIST

GetCtResource

SystemMonitor

ctMBprefix

GetCtTempFileName

TestFileNbr

CtreeAsynchronous

GetSerialNbr

TestHugeFile

CtreeFlushFile

GetXtdCreateBlock

UpdateCtResource

CtreeFlushFileXtd

PartitionAdmin

vtclose

CtreeUserOperation

SetCallbackOnRebuild

 

 

Data Integrity Verification

The following utility functions are used to verify the integrity of data and/or index files.

ctVerifyFile (ctVerifyFile, ctVerifyFile)

ctVerifyFile (ctVerifyFile, ctVerifyFile)

Verifies integrity of a file

ctVERIFYidx (ctVERIFYidx, ctVERIFYidx)

ctVERIFYidx (ctVERIFYidx, ctVERIFYidx)

Verifies integrity of a file

 

Server Administration API

The following utility functions are specific to Client/Server operation.

IOPERFORMANCE

SA_LOGOF

StopServer

IOPERFORMANCEX

SA_LOGON

StopServerXtd

LockDump

SA_USERS

StopUser

Perform

SA_WILDCARD

StopUserAsync

SA_FILES

Security

SystemLog

SA_GROUP

SetNodeName

 

 

Transaction Processing API

The following utility functions control transaction processing.

Abort

ClearTranError

RestoreSavePoint

AbortXtd

Commit

SETLOGPATH

Begin

CtreeCheckPoint

SetSavePoint

ChangeHistory

FreeHistory

TransactionHistory

ClearSavePoint

FreeHistoryNbr

 

 

File Copy Functions

The following functions are used for copying files between FairCom DB Servers.

ctCopyFile

ctfcpSetErrorBuffer()

ctfcpSetCopyFilePassword()

ctfcpAllocateHandle()

ctfcpGetErrorBuffer()

ctfcpSetServerParameters()

ctfcpFreeHandle()

ctfcpSetCallback()

ctfcpCopyFile()

ctfcpAddFileCopyOperation()

ctfcpSetCopyOptions()

 

ctfcpRemoveFileCopyOperation()

ctfcpSetCopyFilenames()

 

 

API Functions Sorted by Type - ISAM Functions

The list below groups the ISAM functions according to the type of function.

General ISAM Functions

InitISAM - Initialize file structures and index buffer area.

InitISAMXtd - Initialize file structures and index buffer area (extended version).

LockISAM - Enable, free or suspend data record locks.

ReadIsamData - ISAM read data at record position.

ReadIsamVData - ISAM read variable-length data at record position.

TransformXtdSegment - Creates a binary sort key (segment) using an extended key segment definition.

Batch Operations

AllocateBatch - Allocates buffer space for multiple batches

ChangeBatch - Change current batch

DoBatch - Perform operations on a group of records.

DoBatchXtd - Perform operations on a group of records (extended version).

FreeBatch - Free space allocated for multiple batches (groups of records).

Context Functions

ChangeISAMContext - Change current ISAM context

CloseISAMContext - Close current ISAM context

OpenISAMContext - Opens (creates) an ISAM context.

File Functions

CloseCtFileByName - Close a memory file and remove it from memory

CloseISAM - Close all ISAM files

CurrentFileOffset - Returns the byte position, (file address or offset), of the current ISAM record for the specified file.

CompactIFile - Compresses a data file then rebuilds to regenerate the indexes

CompactIFileXtd - Compresses a data file, then rebuilds to regenerate the indexes.

CompactIFileXtd8 - Compresses a data file, then rebuilds to regenerate the indexes.

CreateISAM - Create all the ISAM files.

CreateISAMXtd - Extended ISAM file creation routine.

DeleteRFile - Delete ISAM file and associated indexes.

OpenISAM - Open all the ISAM files.

OpenISAMXtd - Open all the ISAM files (extended version).

History Functions

ChangeHistory - Change current history buffer

FreeHistory - Free space allocated for multiple history buffers.

IFile Functions

CloseIFile - Incremental ISAM close

CloseRFile - Incremental ISAM close for files opened by Resource IFIL open

CreateIFile - Incremental ISAM create.

CreateIFileXtd - Extended incremental ISAM creation.

CreateIFileXtd8 (CreateIFileXtd8, CreateIFileXtd8) - Extended 8-byte incremental ISAM creation.

DeleteIFile - Delete ISAM file and associated indexes.

GetIFile - Retrieve an IFIL structure from a data file

OpenIFile - Incremental ISAM open.

OpenFileWithResource - Incremental ISAM open, based on the IFIL Resource.

OpenFileWithResourceXtd - Incremental ISAM open, based on the IFIL Resource (extended).

OpenIFileXtd - Extended Incremental ISAM open.

PutIFile - Place an IFIL structure into a data file resource record.

PutIFileXtd - Place an IFIL structure into a data file resource record. (Extended version)

PutIFileXtd8 - Put an IFIL structure into a data file resource record. Extended 8-byte version.

RebuildIFile - Incremental ISAM rebuild.

RebuildIFileXtd - Extended Incremental ISAM rebuild.

RebuildIFileXtd8 - Extended 8-byte Incremental ISAM rebuild.

RenameIFile - Atomically rename some or all of the files associated with the IFIL structure.

RenameIFileXtd - Rename ISAM files, extended version.

Index Functions

DropIndex - Permanent Incremental Index deletion.

GetConditionalIndex (GetConditionalIndex, /doc/ctreeplus/getconditionalindex.htm) - Get the conditional index resource from a data file.

PermIIndex - Permanent Incremental Index creation.

PermIIndex8 - Permanent 8-byte Incremental Index creation.

RebuildIIndex - Rebuilds a single index.

TempIIndexXtd - Temporary Incremental Index creation.

TempIIndexXtd8 - Extended 8-byte temporary Incremental Index creation.

UpdateConditionalIndex (UpdateConditionalIndex, /doc/ctreeplus/updateconditionalindex.htm) - Update the Conditional Index Resource in a data file.

Key Functions

CurrentISAMKey - Create an ISAM key from the current ISAM record.

GetXtdKeySegmentDef (GetXtdKeySegmentDef, GetXtdKeySegmentDef) - ISAM data definition: Retrieves the requested extended key segment definition.

PutXtdKeySegmentDef (PutXtdKeySegmentDef, PutXtdKeySegmentDef) - Defines an extended key segment for a Server, an application, a data file, an index file, or a particular index segment.

TransformKey - Transforms an assembled key value according to the ISAM key segment mode

uTFRMKEY - Undo key segment translation to target key.

Notifications

ctCallback - Establish a notification callback.

ctNotify - Send notification messages to a queue.

Queue Management

ctSysQueueClose - Closes an existing queue.

ctSysQueueLIFOWrite - Add new data at the beginning of a queue.

ctSysQueueMlen - Retrieves the length of the next available message in the queue.

ctSysQueueOpen (ctSysQueueOpen, ctSysQueueOpen) - Open or create a new queue.

ctSysQueueRead - Read data from the queue.

ctSysQueueWrite - Add new data at the end of a queue.

Range Functions

AllocateRange - Establishes index range for ISAM record retrieval

EstimateRange - Find the approximate number of entries between two key values.

FirstInRange - Read the first data record in a range

FirstInVRange - Read the first data record in a range

FreeRange - Reset and free allocated buffers for range operation

LastInRange - Read the last data record in a range

LastInVRange - Read the last data record in a range

NextInRange - Read the next data record in a range

NextInVRange - Read the next data record in a range

PreviousInRange - Read the previous record in a range

PreviousInVRange - Read the previous record in a range

Records

AddRecord - Fixed-length record add

AddVRecord - Variable-length record add

BlockingISAMRead - Blocking record read

DeleteRecord - Delete current fixed-length ISAM record.

DeleteVRecord - Delete current variable-length ISAM record.

FirstRecord - Read the first data record.

FirstVRecord - Read the first variable-length data record.

GetGTERecord - Read the record with key greater than or equal to target.

GetGTEVRecord - Read the variable-length record with key greater than or equal to target.

GetGTRecord - Read the record with key greater than target.

GetGTVRecord - Read the variable-length record with key greater than target.

GetLTERecord - Read the record with key less than or equal to target.

GetLTEVRecord - Read the variable-length record with key less than or equal to target.

GetLTRecord - Read the record with key less than target.

GetLTVRecord - Read the variable-length record with a key less than target.

GetRecord - Get data record with key equal to target value.

GetVRecord - Read the variable-length record with a key equal to target.

LastRecord - Read the last data record.

LastVRecord - Read the last variable-length data record.

NextRecord - Read the next data record.

NextVRecord - Read the next variable-length data record in the data file.

PreviousRecord - Read the preceding data record.

PreviousVRecord - Read the previous variable-length data record in the data file.

ReReadRecord - Reread current ISAM record.

ReReadVRecord - Reread variable-length ISAM data record.

ResetRecord - Updates the current ISAM record image buffers.

ReWriteRecord - Rewrite current fixed-length ISAM record.

ReWriteVRecord - Rewrite current variable-length ISAM record.

SetRecord - Resets the current ISAM record.

VRecordLength - Get length of current variable-length ISAM record.

Sets

AllocateSet - Allocates buffer space for multiple sets

ChangeSet - Change current set

FirstInSet - Read the first data record in the set defined by target.

FirstInVSet - Read the first variable-length data record in the set defined by target.

FreeSet - Free space allocated for multiple sets.

LastInSet - Read the last data record in the set defined by a target.

LastInVSet - Read the last variable-length data record in the set defined by target.

NextInSet - Read the next data record in the set defined by target.

NextInVSet - Read the next variable-length data record in the set defined by target.

PositionSet - Establish current ISAM record as current position in set.

PositionVSet - Establish current variable-length ISAM record as current position in set.

PreviousInSet - Read the previous data record in the current key value set.

PreviousInVSet - Read the previous variable-length data record in the set defined by target.