Table of Btrieve API Operations

Table of Btrieve API Operations

Table 52

Quick Reference of Btrieve API Operations

Makes a file available for access.

Releases a file from availability.

Inserts a new record into a file.

Updates the current record.

Removes the current record from the file.

Returns the record whose key value matches the specified key value.

Returns the record following the current record in the index path.

Returns the record preceding the current record in the index path.

Get Greater Than

Returns the record whose key value is greater than the specified key value.

Get Greater Than or Equal

Returns the record whose key value is equal to or greater than the specified key value.

Returns the record whose key value is less than the specified key value.

Get Less Than or Equal

Returns the record whose key value is equal to or less than the specified key value.

Returns the first record in the specified index path.

Returns the last record in the specified index path.

Creates a file with the specified characteristics.

Returns file and index characteristics, and number of records.

Divides a data file over two logical disk drives. This operation is not supported in Btrieve 6.0 and later.

Sets the current directory to a specified pathname.

Returns the current directory for a specified logical disk drive.

Begin Transaction

Marks the beginning of a set of logically related operations. Operation 19 begins an exclusive transaction. Operation 1019 begins a concurrent transaction.

End Transaction

Marks the end of a set of logically related operations.

Abort Transaction

Removes operations performed during an incomplete transaction.

Returns the position of the current record.

Get Direct/Chunk

Returns data from the specified portions (chunks) of a record at a specified position.

Get Direct/Record

Returns the record at a specified position.

Returns the record from the physical location following the current record.

Terminates the workstation transactional interface (not available for server-based transactional interfaces).

Returns the version number of the transactional interface.

Unlocks a record or records.

Releases all resources held by a client.

Assigns an owner name to a file.

Removes an owner name from a file.

Creates an index.

Removes an index.

Returns the record in the first physical location in the file.

Returns the record in the last physical location in the file.

B_STEP_PREVIOUS

Returns the record in the physical location preceding the current record.

Get Next Extended

B_GET_NEXT_EXTENDED

Returns one or more records that follow the current record in the index path. Filtering conditions can be applied.

Get Previous Extended

B_GET_PREV_EXTENDED

Returns one or more records that precede the current record in the index path. Filtering conditions can be applied.

Step Next Extended

B_STEP_NEXT_EXT

Returns one or more successive records from the location physically following the current record. Filtering conditions can be applied.

Step Previous Extended

B_STEP_PREVIOUS_EXT

Returns one or more preceding records from the location physically preceding the current record. Filtering conditions can be applied.

Insert Extended

Inserts one or more records into a file.

Continuous Operation

Allows system backups without closing active transactional interface files.

Get By Percentage

Returns the record located approximately at a position derived from the specified percentage value.

Find Percentage

Returns a percentage figure based on the current record’s position in the file.

Detects the presence of a key value in a file, without returning an actual record.

Updates specified portions (chunks) of the current record. This operation can also append data to a record or truncate a record.

B_EXTENDED_STAT

Returns filenames and paths of an extended file’s components and reports whether a file is using a system-defined log key.

Single-record wait lock

Locks only one record at a time. If the record is already locked, the transactional interface retries the operation.

Single-record
no-wait lock

Locks only one record at a time. If the record is already locked, the transactional interface returns an error status code.

Multiple-record wait lock

Locks several records concurrently in the same file. If the record is already locked, the transactional interface retries the operation.

Multiple-record
no-wait lock

Locks several records concurrently in the same file. If the record is already locked, the transactional interface returns an error status code.

No-wait page lock

In a concurrent transaction, tells the transactional interface not to wait if the page to be changed has already been changed by another active concurrent transaction. This bias can be combined with any of the record locking biases (+100, +200, +300, or +400).