Function API Listing

This document lists the c-tree Plus Function API alphabetically.

Click here to view this list broken into functional groupings -- Initializion, Definition, Manipulation, and Utility.

Abort Abort the current transaction in progress.

AbortXtd Abort the current transaction in progress (extended version).

AddCtResource Add a Resource to a data file.

AddKey Add key value to index file.

AddRecord Add a new fixed-length data record and corresponding key values to ISAM files.

AddVRecord Add a new variable-length data record, and its corresponding key values, to ISAM files.

AllocateBatch Optionally allocates buffer space for multiple batches (groups of records).

AllocateSet Optionally allocates buffer space for multiple sets.

AvailableFileNbr Return next available c-tree Plus file number.

Begin Mark beginning of transaction.

BuildKey Perform key segment translation from record buffer to target key.

ChangeBatch Change current batch (group of records).

ChangeHistory Change current history buffer.

ChangeISAMContext Change current ISAM context.

ChangeSet Change current set.

CleanIndexXtd Clean up any leaf node exceptions and reset high water mark.

ClearSavePoint Remove the last savepoint without undoing other changes.

ClearTranError Clear an error in an active transaction.

CloseCtFile Close index or data file.

CloseIFile Incremental ISAM close.

CloseISAM Close all ISAM files.

CloseISAMContext Close current ISAM context.

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

Commit Commit the current transaction in progress.

CompactIFile Compresses a data file, then rebuilds to regenerate the indices.

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

cpybuf Copy one buffer area to another regardless of any null characters.

CreateDataFile Create a data file.

CreateDataFileXtd Extended data file creation.

CreateDataFileXtd8 Extended 8 byte data file creation.

CreateIFile Incremental ISAM create.

CreateIFileXtd Extended Incremental ISAM creation.

CreateIFileXtd8 Extended 8 byte Incremental ISAM creation.

CreateIndexFile Create an index file.

CreateIndexFileXtd Extended index file creation.

CreateIndexFileXtd8 Extended 8 byte index file creation.

CreateIndexMember Create an additional index file member.

CreateISAM Create all the ISAM files.

CreateISAMXtd Extended ISAM file creation routine.

ctFILELIST Manages file-specific cache features.

ctGETHGH Retrieve the high-order four bytes of an 8 byte record address.

ctMBprefix Stores a proper prefix to a Unicode filename string.

CtreeAsynchronous Deals with asynchronous threads launched by an application.

CtreeCheckPoint Force a system checkpoint to the transaction logs.

CtreeFlushFile Force c-tree Plus and system file buffers to disk.

CtreeFlushFileXtd Flush cache for specific files and groups of files.

CtreeUserOperation Execute a developer-defined function.

ctSETHGH Set the high-order four bytes of an 8 byte record address.

ctThrdAttach Make an existing thread c-tree Plus compatible.

ctThrdBlockCls Close a block.

ctThrdBlockGet Get a thread block.

ctThrdBlockInit Initialize memory for a thread block.

ctThrdBlockRel Releases a block.

ctThrdBlockWait Wait for a block to clear.

ctThrdCreate Create a c-tree Plus thread.

ctThrdData Returns a pointer to a private data area.

ctThrdDataSet Set a pointer to a private data area.

ctThrdDetach Clean up the c-tree Plus compatibility created with ctThrdAttach.

ctThrdExit Clean up thread.

ctThrdHandle Returns a thread identifier.

ctThrdInit Initialize thread management.

ctThrdLIFOWrite Write a message at the beginning of a queue.

ctThrdMutexCls Closes a mutex.

ctThrdMutexGet Acquires a mutex.

ctThrdMutexInit Initialize memory for a mutex.

ctThrdMutexRel Releases a mutex.

ctThrdMutexTry Try to acquire mutex immediately.

ctThrdQueueClose Close a message queue.

ctThrdQueueCount Returns the number of entries in a queue.

ctThrdQueueMlen Returns the length of the message at the beginning of a queue.

ctThrdQueueOpen Open a message queue.

ctThrdQueueRead Read a queue message.

ctThrdQueueReadDirect Read a queue message pointer.

ctThrdQueueWrite Write a queue message.

ctThrdQueueWriteDirect Write a queue message pointer.

ctThrdSemapCls Close a semaphore.

ctThrdSemapGet Get one unit of a semaphore.

ctThrdSemapInit Initialize a semaphore.

ctThrdSemapRel Release one unit of a semaphore.

ctThrdSemapTry Try once to get one unit of a semaphore.

ctThrdSleep Sleep a thread for a given time.

ctThrdTerm Terminate threading support.

ctu16tou8 Converts a UTF16 Unicode string to a UTF8 encoded string.

ctu8tou16 Converts an ASCII or UTF8 Unicode string to a UTF16 encoded string.

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

CurrentISAMKey Create an ISAM key from the current ISAM record.

CurrentLowLevelKey Get a key from the current low-level key buffer.

DeleteCtFile Delete c-tree Plus file.

DeleteCtResource Delete Resource from file.

DeleteIFile Delete ISAM file and associated indices.

DeleteKey Delete key value verifying associated data record position.

DeleteKeyBlind Delete key value when associated data record position is not known.

DeleteRecord Delete current fixed length ISAM record.

DeleteRFile Delete ISAM file and associated indices.

DeleteVRecord Delete current variable length ISAM record.

DoBatch Perform operations on a group of records.

DropIndex Permanent Incremental Index deletion.

EnableCtResource Enable Resources in a file created without resources enabled.

EstimateKeySpan Find the approximate number of entries between two key values.

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.

FirstKey Find the first entry in an index file.

FirstRecord Read the first data record.

FirstVRecord Read the first variable-length data record.

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

FreeBatchNbr Free space allocated for a specific batch.

FreeHistory Free space allocated for multiple history buffers.

FreeHistoryNbr Free space allocated for a transaction history.

FreeSet Free space allocated for multiple sets.

FreeSetNbr Free space allocated for a specific set.

GetAltSequence Retrieve information from a data file relating to an alternate collating sequence that has been stored as a Resource.

GetConditionalIndex Get the Conditional Index Resource from a data file.

GetCtFileInfo Retrieve information from a file header.

GetCtreePointer Return a pointer to a c-tree Plus state variable structure (CTGVAR).

GetCtResource Get Resource record from data file.

GetCtTempFileName Create a file name that is guaranteed to be unique or specify path for creation of temporary files.

GetDODA Retrieve information from a record schema stored as a resource.

GetGTEKey Search index file for entry equal to or greater than target.

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.

GetGTKey Search index file for entry greater than target.

GetGTRecord Read the record with key greater than target.

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

GetIFile Retrieve an IFIL structure from a data file.

GetKey Search index file for entry equal to target value.

GetLTEKey Search index file for entry equal to or less 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.

GetLTKey Search index file for entry less than target.

GetLTRecord Read the record with key less than target.

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

GetORDKey Return the record offset (recbyt) to the nth offset past the given target.

GetRecord Get data record with key equal to target value.

GetSerialNbr Get current data file sequence number.

GetServerInfo Get Server broadcast information via TCP/IP.

GetServerInfoXtd Listen for server information via TCP/IP, Extended Version.

GetSuperFileNames Retrieve superfile member name.

GetSymbolicNames Retrieve symbolic information about file.

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

GetXtdCreateBlock Retrieves the extended file creation block, XCREblk.

GetXtdKeySegmentDef Retrieves the requested extended key segment definition.

InitCTree Initialize file structures and index buffer area.

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

InitISAM Initialize file structures and index buffer area.

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

IOPERFORMANCE Monitor Input/Output of data/index caching and count low- level file reads and writes.

IOPERFORMANCEX Monitor Input/Output of data/index caching and count low- level file reads and writes.

KeyAtPercentile Find key value located at about the given percentile.

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.

LastKey Find the last entry in an index file.

LastRecord Read the last data record.

LastVRecord Read the last variable-length data record.

LoadKey Add key value to index file in presorted order.

LockCtData Lock / unlock data records.

LockDump Dump the c-tree Server internal lock table.

LockISAM Enable, free or suspend data record locks.

NbrOfKeyEntries Number of entries in index file.

NbrOfKeysInRange Return the number of active index entries found between two targets.

NbrOfRecords Get the number of active records in fixed length data file.

NewData Get next available fixed length data record position.

NewVData Get next available fixed length data record position.

NextCtree Change to the next registered c-tree Plus instance.

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.

NextKey Find the next entry in an index file.

NextRecord Read the next data record.

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

OpenCtFile Open a data file.

OpenCtFileXtd Extended data or index file open.

OpenFileWithResource Incremental ISAM open, based on the IFIL Resource.

OpenFileWithResourceXtd Initialize file structures and index buffer area.

OpenIFile Incremental ISAM open.

OpenIFileXtd Extended Incremental ISAM open.

OpenISAM Open all the ISAM files.

OpenISAMContext Opens (creates) an ISAM context.

OpenISAMXtd Open all the ISAM files (extended version).

PartitionAdmin Partition file administration function.

Perform Evaluate c-tree Server performance.

PermIIndex Permanent Incremental Index creation.

PermIIndex8 Permanent 8 byte Incremental Index creation.

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.

PreviousKey Find the previous entry in an index file.

PreviousRecord Read the preceding data record.

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

PutDODA Store information from a record schema as a resource.

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.

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

ReadData Read fixed-length data record.

ReadIsamData ISAM read data at record position.

ReadIsamVData ISAM read variable-length data at record position.

ReadVData Read variable length data record.

RebuildIFile Incremental ISAM rebuild.

RebuildIFileXtd Extended Incremental ISAM rebuild.

RebuildIFileXtd8 Extended 8 byte Incremental ISAM rebuild.

RebuildIIndex Rebuilds a single index.

RegisterCtree Register (establish) a c-tree Plus instance.

ReleaseData Release fixed-length data record for reuse.

ReleaseVData Release variable-length data record for reuse.

RenameFile Rename a file.

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

RenameIFileXtd Rename ISAM files, extended version.

ReplaceSavePoint Establish a savepoint while clearing the previous one.

ReReadRecord Reread current ISAM record.

ReReadVRecord Reread variable-length ISAM data record.

ResetRecord Updates the current ISAM record image buffers.

RestoreSavePoint Undo transaction operations back to a savepoint.

ReWriteRecord Rewrite current fixed-length ISAM record.

ReWriteVRecord Rewrite current variable-length ISAM record.

SA_FILES Performs c-tree Server file administration operations.

SA_GROUP Performs operations on c-tree Server Groups.

SA_LOGOF Close administration files and disconnect from the c-tree Server.

SA_LOGON Connects to the c-tree Server in preparation for administration.

SA_USERS Perform user-related Server Administration.

Security Modifies a file's password, group ID, and permission mask.

SetAlternateSequence Establishes an Alternate Collating Sequence for an index file.

SetCallbackOnRebuild Sets up a callback function that file reconstruction functions call as progress is made during an operation.

SetDataFilter Specify a data filter for a given data file.

SetEncryption Set or reset encryption key.

SetFileSegments Segmented file support configuration function.

SETLOGPATH Set transaction processing control file paths for single-user applications.

SetNodeName Sets a client side node name.

SetOperationState Set operation modes for special performance-related functionality and test operational states for critical events.