Open

B_OPEN

Makes a file available for access.

Close

B_CLOSE

Releases a file from availability.

Insert

B_INSERT

Inserts a new record into a file.

Update

B_UPDATE

Updates the current record.

Delete

B_DELETE

Removes the current record from the file.

Get Equal

B_GET_EQUAL

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

Get Next

B_GET_NEXT

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

Get Previous

B_GET_PREVIOUS

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

Get Greater Than

B_GET_GT

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

Get Greater Than or Equal

B_GET_GE

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

Get Less Than

B_GET_LT

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

Get Less Than or Equal

B_GET_LE

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

Get First

B_GET_FIRST

Returns the first record in the specified index path.

Get Last

B_GET_LAST

Returns the last record in the specified index path.

Create

B_CREATE

Creates a file with the specified characteristics.

Stat

B_STAT

Returns file and index characteristics, and number of records.

Extend

B_EXTEND

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

Set Directory

B_SET_DIR

Sets the current directory to a specified path name.

Get Directory

B_GET_DIR

Returns the current directory for a specified logical disk drive.

Begin Transaction

B_BEGIN_TRAN

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

End Transaction

B_END_TRAN

Marks the end of a set of logically related operations.

Abort Transaction

B_ABORT_TRAN

Removes operations performed during an incomplete transaction.

Get Position

B_GET_POSITION

Returns the position of the current record.

Get Direct/Chunk

B_GET_DIRECT

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

Get Direct/Record

B_GET_DIRECT

Returns the record at a specified position.

Step Next

B_STEP_NEXT

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

Stop

B_STOP

Terminates the Workgroup MicroKernel Engine. Not available for other instances of MicroKernel Engine.

Version

B_VERSION

Returns the version number of the MicroKernel Engine.

Unlock

B_UNLOCK

Unlocks a record or records.

Reset

B_RESET

Releases all resources held by a client.

Set Owner

B_SET_OWNER

Assigns an owner name to a file.

Clear Owner

B_CLEAR_OWNER

Removes an owner name from a file.

Create Index

B_BUILD_INDEX

Creates an index.

Drop Index

B_DROP_INDEX

Removes an index.

Step First

B_STEP_FIRST

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

Step Last

B_STEP_LAST

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

Step Previous

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

B_EXT_INSERT

Inserts one or more records into a file.

Continuous Operation

B_CONTINUOUS

Allows system backups without closing active MicroKernel Engine files.

Get By Percentage

B_SEEK_PERCENT

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

Find Percentage

B_GET_PERCENT

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

Get Key

KEY_BIAS

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

Update Chunk

B_CHUNK_UPDATE

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

Stat Extended

B_EXTENDED_STAT

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

Login/Logout

B_LOGIN/B_LOGOUT

Enters user credentials to obtain authentication and authorization tokens from the database engine, or resets the credentials so that they must be entered again.

Get Next Delete Extended

B_GET_NEXT_EXT_DELETE

Removes records matching a filter condition, from the logical next position to the end of the file.

Get Previous Delete Extended

B_GET_PREV_EXT_DELETE

Removes records matching a filter condition, from the logical previous position to the beginning of the file.

Step Next Delete Extended

B_STEP_NEXT_EXT_DELETE

Removes records matching a filter condition, from the physical next position to the end of the file.

Step Previous Delete Extended

B_STEP_PREV_EXT_DELETE

Removes records matching a filter condition, Removes records matching a filter condition, from the physical previous position to the beginning of the file.

Single-record wait lock

S_WAIT_LOCK

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

Single-record
no-wait lock

S_NOWAIT_LOCK

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

Multiple-record wait lock

M_WAIT_LOCK

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

Multiple-record
no-wait lock

M_NOWAIT_LOCK

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

No-wait page lock

NOWRITE_WAIT

In a concurrent transaction, tells the MicroKernel Engine 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).