Product Documentation

FairCom ISAM for C

Previous Topic

Next Topic

FairCom DB Function Descriptions

The FairCom DB® function definitions are presented in alphabetical order, each starting on a new page, to facilitate your search for information.

Function definitions include some or all of the following sections:

Short Name

Internal FairCom DB function name. See Function Name Cross Reference for a cross-reference.

Type

ISAM, Low-Level, Server only, Server admin, threading, or utility function

Declaration

Function and parameter declarations

Description

Detailed description

Return

Explanation of most common return values. See FairCom DB Error Codes for additional error explanations.

Example

Programming example

Limitations

Restrictions on use and/or shortcomings

See also

Related functions and information

After each FairCom DB function call, a global variable will contain the current error code, or zero if no error occurred. In the case of all types except ISAM, the error code variable is uerr_cod. Some of the FairCom DB Low-Level functions also set the global variable sysiocod to the value of errno when a C runtime function experiences an I/O error. errno is the Language C run-time error variable automatically maintained by the C run-time library. Unlike uerr_cod, sysiocod is not reset by new calls to FairCom DB. It is only set to errno if an open, create, seek, read, write, or lock function fails. The FairCom DB ISAM functions set the variable isam_err. In addition, the ISAM functions set the variable isam_fil with the data or index file number involved.

The error codes listed in each Return section of the function descriptions are not exhaustive. The only error codes included are those which have a meaningful context for the function in question.

In This Chapter

Abort

AbortXtd

AddAutoSysTimeFields

addChangeIDfield

AddCtResource

addIDfield

AddKey

AddRecord

AddVRecord

AllocateBatch

AllocateRange

AllocateSet

AvailableFileNbr

Begin

BlockingISAMRead

BuildKey

ChangeBatch

ChangeHistory

ChangeISAMContext

ChangeSet

CleanIndexXtd

ClearSavePoint

ClearTranError

CloseConnection

CloseCtFile

CloseCtFileByName

CloseIFile

CloseISAM

CloseISAMContext

CloseRFile

cndxeval

cndxfree

cndxparse

cndxrun

Commit

CompactIFile

CompactIFileXtd

CompactIFileXtd8

cpybuf

CreateDataFile

CreateDataFileXtd

CreateDataFileXtd8

CreateIFile

CreateIFileXtd

CreateIFileXtd8

CreateIndexFile

CreateIndexFileXtd

CreateIndexFileXtd8

CreateIndexMember

CreateISAM

CreateISAMXtd

ctAlterSchema

ctCallback

ctCloseSequence

ctCopyFile

ctCreateSequence

ctDeferredIndexControl

ctDeleteSequence

ctfcpAddFileCopyOperation

ctfcpAllocateHandle

ctfcpCopyFile

ctfcpFreeHandle

ctfcpGetErrorBuffer

ctfcpRemoveFileCopyOperation

ctfcpSetCallback

ctfcpSetCopyFilenames

ctfcpSetCopyFilePassword

ctfcpSetCopyOptions

ctfcpSetErrorBuffer

ctfcpSetServerParameters

ctFILBLK

ctFILBLKX

ctFILELIST

ctFILMTX

ctfiltercb_rowl

ctfiltercbAddFilter

ctfiltercbRemoveFilter

ctGetAccountExpirationTime

ctGetConnectionInfo

ctGetCurrentSequenceValue

ctGetFailOverState

ctGetFileLocks

ctGetFileUsers

ctGETHGH

ctGetIsamErrorCode

ctGetIsamFileNbr

ctGetNextSequenceValue

ctGetNullBit

ctGetNullKeyValue

ctGetOpenFiles

ctGetOpenFilesXtd

ctGetSequenceAttrs

ctGetSystemErrorCode

ctGetUserErrorCode

ctImpersonateTask

ctLOKDYN

ctLOKTIMOUT

ctMBprefix

ctNotify

ctOpenSequence

ctparsedoda

ctPlugin

ctPlugin_describe

ctPlugin_init

ctPlugin_term

ctRecordUpdateCallbackControl

CtreeAsynchronous

CtreeCheckPoint

CtreeFlushFile

CtreeFlushFileXtd

ctResetFailOverState

ctSetClientLibraryOption

ctSetCommProtocolOption

ctSetCompress

ctSetConfigurationOptions

ctSetCurrentSequenceValue

ctSETHGH

ctSetLicenseFile

ctSetLicenseOptions

ctSetLocalDirectory

ctSetNullBit

ctSetNullKeyValue

ctSetOWNER

ctSetSequenceAttrs

ctSQLImportTable

ctStatusLogWrite

ctSysQueueClose

ctSysQueueCount

ctSysQueueLIFOWrite

ctSysQueueMlen

ctSysQueueOpen

ctSysQueueRead

ctSysQueueWrite

ctThrdAttach

ctThrdBlockCls

ctThrdBlockGet

ctThrdBlockInit

ctThrdBlockRel

ctThrdBlockWait

ctThrdCreate

ctThrdData

ctThrdDataSet

ctThrdDetach

ctThrdExit

ctThrdHandle

ctThrdInit

ctThrdLIFOWrite

ctThrdLIFOWriteDirect

ctThrdMutexCls

ctThrdMutexGet

ctThrdMutexInit

ctThrdMutexRel

ctThrdMutexTry

ctThrdQueueClose

ctThrdQueueCount

ctThrdQueueMlen

ctThrdQueueOnClose

ctThrdQueueOpen

ctThrdQueueRead

ctThrdQueueReadDirect

ctThrdQueueWrite

ctThrdQueueWriteDirect

ctThrdSemapCls

ctThrdSemapGet

ctThrdSemapInit

ctThrdSemapRel

ctThrdSemapTry

ctThrdSleep

ctThrdTerm

ctTransferFile

ctTruncateFile

ctu16TOu8

ctu8TOu16

ctUPDICU

ctVerifyFile

ctVERIFYidx

CurrentFileOffset

CurrentISAMKey

CurrentLowLevelKey

delChangeIDfield

DeleteCtFile

DeleteCtResource

DeleteIFile

DeleteKey

DeleteKeyBlind

DeleteRecord

DeleteRFile

DeleteVRecord

DELFILX

delIDfield

DELIFILX

DELRFILX

DoBatch

DoBatchXtd

DropIndex

dyndmp and dyndumpsetopt

EnableCtResource

EstimateKeySpan

EstimateRange

EvaluateFilter

FindFileByName

FirstInRange

FirstInSet

FirstInVRange

FirstInVSet

FirstKey

FirstRecord

FirstVRecord

FreeBatch

FreeBatchNbr

FreeHistory

FreeHistoryNbr

FreeRange

FreeSet

FreeSetNbr

GetAltSequence

getcndxmem

getChangeIDfieldNumber

getChangeIDheaderValue

GetConditionalIndex

GetCtFileInfo

GetCtreePointer

GetCtResource

GetCtTempFileName

GetDODA

GetFileRegions

GetFilterVersion

GetGTEKey

GetGTERecord

GetGTEVRecord

GetGTKey

GetGTRecord

GetGTVRecord

getIDfield

GetIFile

GetKey

GetLTEKey

GetLTERecord

GetLTEVRecord

GetLTKey

GetLTRecord

GetLTVRecord

GetORDKey

GetRecord

GetSerialNbr

GetServerInfo

GetServerInfoXtd

GetSuperFileNames

GetSymbolicNames

GetVRecord

GetXtdCreateBlock

GetXtdKeySegmentDef

InitCTree

InitCTreeXtd

InitISAM

InitISAMXtd

IOPERFORMANCE

IOPERFORMANCEX

KeyAtPercentile

LastInRange

LastInSet

LastInVRange

LastInVSet

LastKey

LastRecord

LastVRecord

LoadFilter

LoadKey

LockCtData

LockDump

LockISAM

LockList

NbrOfKeyEntries

NbrOfKeysInRange

NbrOfRecords

NewData

NewVData

NextCtree

NextInRange

NextInSet

NextInVRange

NextInVSet

NextKey

NextRecord

NextVRecord

OpenCtFile

OpenCtFileXtd

OpenFileWithResource

OpenFileWithResourceXtd

OpenIFile

OpenIFileXtd

OpenISAM

OpenISAMContext

OpenISAMXtd

PartitionAdmin

Perform

PermIIndex

PermIIndex8

PositionSet

PositionVSet

PreviousInRange

PreviousInSet

PreviousInVRange

PreviousInVSet

PreviousKey

PreviousRecord

PreviousVRecord

PRMIIDX82

putcndxmem

PutDODA

PutIFile

PutIFileXtd

PutIFileXtd8

PutXtdKeySegmentDef

QuietCtree

ReadData

ReadIsamData

ReadIsamVData

ReadVData

RebuildIFile

RebuildIFileXtd

RebuildIFileXtd8

RebuildIIndex

RegisterCtree

ReleaseData

ReleaseVData

RemoveAutoSysTimeFields

RenameFile

RenameIFile

RenameIFileXtd

ReplaceSavePoint

ReReadRecord

ReReadVRecord

resetIDfield

ResetRecord

RestoreSavePoint

ReWritePartialRecord

ReWriteRecord

ReWriteVRecord

SA_ERRMSG

SA_FILES

SA_GROUP

SA_LOGOF

SA_LOGON

SA_USERS

SA_WILDCARD

SECURITY (function)

SetAlternateSequence

SetCallbackOnRebuild

SetDataFilter

SetEncryption

SetFileSegments

SETFLTRN

SETLOGPATH

SetNodeName

SetOperationState

SetRecord

SetSavePoint

SetSystemConfigurationOption

SetVariableBytes

SetXtdFileOpenMode

SnapShot

StopServer

StopServerXtd

StopUser

StopUserAsync

SuperfilePrepassXtd

SwitchCtree

SystemConfiguration

SystemLog

SystemMonitor

TempIIndexXtd

TempIIndexXtd8

TestFileNbr

TestHugeFile

TRANRDY

TransactionHistory

TransformKey

TransformSegment

TransformXtdSegment

UnloadFilter

UnRegisterCtree

UpdateAutoSysTimeFields

UpdateConditionalIndex

UpdateCtResource

UpdateFileMode

UpdateHeader

UpdateRecordOffsetForKey

USERINFOX

USERLIST

UserLogEntry

uTFRMKEY

VDataLength

VRecordLength

vtclose

wchIDfield

WhichAutoSysTimeFields

WhichCtree

WriteData

WriteVData

TOCIndex