Btrieve API Guide - Index
A -
B -
C -
D -
E -
F -
G -
H -
I -
K -
L -
M -
N -
O -
P -
R -
S -
T -
U -
V -
W
A
Abort Transaction (21)
Abort Transaction operation
Accelerated file open mode 1 2
ACS. See Alternate collating sequence.
Adding
index to an existing file
ALT constant
Alternate collating sequence
Create operation and
creating keys that use
flag in Stat operation for
ISR
user-defined
AND and OR operations in filters
Ascending sort order
Attributes
file
key
B
B_ABORT_TRAN
B_BEGIN_TRAN
B_BUILD_INDEX
B_CHUNK_UPDATE
B_CLEAR_OWNER
B_CLOSE
B_CONTINUOUS
B_CREATE
B_DELETE
B_DROP_INDEX
B_END_TRAN
B_EXT_INSERT
B_EXTEND
B_EXTENDED_STAT
B_GET_DIR
B_GET_DIRECT 1 2
B_GET_EQUAL
B_GET_FIRST
B_GET_GE
B_GET_GT
B_GET_LAST
B_GET_LE
B_GET_LT
B_GET_NEXT
B_GET_NEXT_EXTENDED
B_GET_PERCENT
B_GET_POSITION
B_GET_PREV_EXTENDED
B_GET_PREVIOUS
B_INSERT
B_LOGIN
B_MISC_DATA
B_OPEN
B_RESET
B_SEEK_PERCENT
B_SET_DIR
B_SET_OWNER
B_STAT
B_STEP_FIRST
B_STEP_LAST
B_STEP_NEXT
B_STEP_NEXT_EXT
B_STEP_PREVIOUS
B_STEP_PREVIOUS_EXT
B_STOP
B_UNLOCK
B_UPDATE
B_VERSION
Balanced indexes
BALANCED_KEYS constant
Begin Transaction (19 or 1019)
Begin Transaction operation
BIN constant
Blank truncation
BLANK_TRUNC constant
BRQSHELLINIT function
BTRCALL function
BTRCALL32 function
BTRCALLBACK function
BTRCALLID function
BTRCALLID32 function
Btrieve
function parameters
functions
unsupported features
Btrieve API
Abort Transaction (21)
Begin Transaction (19 or 1019)
Clear Owner (30)
Close (1)
Continuous Operation (42)
Create (14)
Create Index (31)
Delete (4)
Drop Index (32)
End Transaction (20)
Find Percentage (45)
Get By Percentage (44)
Get Direct/Chunk (23)
Get Direct/Record (23)
Get Directory (18)
Get Equal (5)
Get First (12)
Get Greater (8)
Get Greater Than or Equal (9)
Get Key (+50)
Get Last (13)
Get Less Than (10)
Get Less Than or Equal (11)
Get Next (6)
Get Next Extended (36)
Get Position (22)
Get Previous (7)
Get Previous Extended (37)
Insert (2)
Insert Extended (40)
Login/Logout (78)
Open (0)
operations
Reset (28)
Set Directory (17)
Set Owner (29)
Stat (15)
Stat Extended (65)
Step First (33)
Step Last (34)
Step Next (24)
Step Next Extended (38)
Step Previous (35)
Step Previous Extended (39)
Stop (25)
Unlock (27)
Update (3)
Update Chunk (53)
Version (26)
BTRV function
BTRVID function
BTRVINIT function
BTRVSTOP function
C
Case-insensitive keys 1 2
Chunk descriptors
Get Direct/Chunk operation and
Update Chunk operation and
Clear Owner (30)
Clear Owner operation
Client transaction
determining if open on file
ClientID parameter
Close (1)
Close operation
Compression, data
Continuous Operation (42)
Continuous Operation operation
Continuous operations
determining if file is in
Continuous Operations
and referential integrity
restriction for files with same name 1 2
Create (14)
Create Index (31)
Create Index operation
Create operation
alternate collating sequence in
data buffer
description of
file specifications in
specifying file version
D
Data Buffer Length parameter
Data Buffer parameter
Data compression
Data encryption
Data manipulation operations
Data retrieval operations
DATA_COMP constant
Data-only files, creating
Delete (4)
Delete operation
Deleting an index
DESC_KEY constant
Descending sort order
Directory
returning the current
setting the current
Drop Index (32)
Drop Index operation
DUP constant
DUP_PTRS constant
Duplicate keys
Duplicate pointers, reserved
Duplicate record conflict
determining source of
E
embedded spaces
Encryption
determining if file has
End Transaction (20)
End Transaction operation
Exclusive file open mode
Explicit locks
determining if on file
Extend operation (obsolete)
Extended data types
Extended key types
Extension files
names of, determining
number of, determining
EXTTYPE_KEY constant
F
File
client transaction, determining if open
continuous operations, determining if file is in
current number of handles, determining
determining if encrypted
determining transaction durability
explicit locks, determining if set
gateway engine
determining name of
determining platform of
determining version of
owner name
determining if opened with wrong
owner name, determining if set
read-only, determining if
referential integrity, determining if set
time last opened, determining
usage count, determining
File access operations
File flags
20% free space
30% free space
do not include system data
use page compression
File flags (attributes)
File information operations
File open mode 1 2 3 4 5
File Open mode 1 2 3
File open modes
File specification block
File version
specifying during Create operation
File-specific operations
Files
closing
creating
extension, see Extension files
opening
statistics
Files with same name
restriction for continuous operations 1 2
Filters for extended operations
Find Percentage (45)
Find Percentage operation
Flags
file 1 2
key
Free space threshold
FREE_10 constant
FREE_20 constant
FREE_30 constant
Functions
Btrieve
G
Gateway engine
determining name of
determining platform of
determining version of
Get By Percentage (44)
Get By Percentage operation
Get Direct/Chunk (23)
Get Direct/Chunk operation
Get Direct/Record (23)
Get Direct/Record operation
Get Directory (18)
Get Directory operation
Get Equal (5)
Get Equal operation
Get First (12)
Get First operation
Get Greater (8)
Get Greater operation
Get Greater Than or Equal (9)
Get Greater Than or Equal operation
Get Key (+50)
Get Key operation
Get Last (13)
Get Last operation
Get Less Than (10)
Get Less Than operation
Get Less Than or Equal (11)
Get Less Than or Equal operation
Get Next (6)
Get Next Extended (36)
Get Next Extended operation
Get Next operation
Get Position (22)
Get Position operation
Get Previous (7)
Get Previous Extended (37)
Get Previous Extended operation
Get Previous operation
GetEqual
NULL key segments and
H
Handles
determining current number on file
I
Include system data
INCLUDE_SYSTEM_DATA constant
Indexes
balanced
creating
dropping
rebuilding
Insert (2)
Insert Extended (40)
Insert Extended operation
Insert operation
International Sort Rules
K
Key Buffer parameter
Key flags (attributes)
Key Length parameter
Key Number parameter
Key numbers, assigning 1 2
Key segments
maximum allowed
Key specification
blocks
Key values, finding specific
KEY_ONLY constant
Key-only files
creating
L
Linked duplicate keys
Lock
determining bias of
determining client ID of
determining duration of
determining if from transaction
determining if implicit or explicit
determining location of conflict
determining name of client
determining owner of
determining source of on key page
determining whether page, record, or file
getting information about
Lock biases
Locks
explicit
determining if set
Login/Logout (78)
M
Manipulation operations
MANUAL_KEY constant
MOD constant
Modifiable keys
Modification operations
Multiple record locks
N
NAMED_ACS constant
Next-in-record subfunction bias 1 2
NO_INCLUDE_SYSTEM_DATA constant
No-currency-change
Insert Extended operation and
Insert operation and
Update operation and
NOCASE_KEY constant
Normal file open mode
NUL constant
NULL key segments
GetEqual and
Null keys 1 2
NUMBERED_ACS constant
O
Obsolete functions
Open
modes
operation
Open (0)
Open mode 1 2 3 4 5 6 7
Operation Code parameter
Operations
for Btrieve API
Owner name
clearing
determining if file opened with wrong
determining if set on file
Owner names
setting
P
Page compression
Page preallocation
PAGE_COMPRESSED constant
Pointers, reserved duplicate
Position Block parameter
PRE_ALLOC constant
R
Random chunk descriptors 1 2
Read-only
determining if file opened as
Read-only file open mode
Rebuilding a damaged index
Record, duplicate conflict
determining source of
Records
deleting
inserting
inserting multiple
updating
Rectangle chunk descriptors 1 2
Referential integrity
and continuous operations
determining if set on file
REPEAT_DUPS_KEY constant
Repeating duplicate keys
Requesters
version, retrieving
Reserved duplicate pointers
Reset (28)
Reset operation
Resources, releasing
Retrieval operations
records
equal to the index path
first in physical location
first in the index path
Get By Percentage operation
Get Direct/Record operation and
getting one or more chunks of a record
greater than or equal to the index path
greater than the index path
last in physical location
last in the index path
less than or equal to the index path
less than the index path
next in physical location 1 2
next in the index path 1 2
previous in physical location 1 2
previous in the index path 1 2
using established physical location
RQSHELLINIT function
S
Scroll bars
SEG constant
Segmented keys
Segments
maximum key segments allowed
Server engine version, retrieving
Session-specific operations
Set Directory (17)
Set Directory operation
Set Owner (29)
Set Owner operation
Single record locks
Sort order
keys
SPECIFY_KEY_NUMS constant
Standard data types
Stat (15)
Stat Extended (65)
Stat Extended operation
Stat operation
Status Code
causes of status code 5
causes of status code 85
determining cause of 86
parameter
Step First (33)
Step Last (34)
Step Next (24)
Step Next Extended (38)
Step operations
Step First operation
Step Last operation
Step Next Extended operation
Step Next operation
Step Previous Extended operation
Step Previous operation
Step Previous (35)
Step Previous Extended (39)
Stop (25)
Stop operation
System data
determining if file has system log key
T
Transaction
aborting
beginning
client, determining if open
ending
log key
determining key number
Transaction durability
determining for file
Truncate chunk descriptors
U
Undocumented features
Unlock (27)
Unlock operation
Unsupported features
Update (3)
Update Chunk (53)
Update Chunk operation
Update operation
Usage count of file, determining
Use page compression flag
Use VATs
User-defined ACSs
V
VAR_RECS constant
Variable-length records
and Extended operations
flag
Variable-tail Allocation Tables (VATs)
VATS_SUPPORT constant
Verify file open mode
Version
specifying during Create operation
Version (26)
Version operation
W
WBRQSHELLINIT function
WBTRVINIT function
WBTRVSTOP function
Workstation engine version, retrieving
Wrong owner name
determining if file opened with
