About This Document
Who Should Read This Document
Typographical Conventions
Introduction to Btrieve APIs
Btrieve API Functions
BTRV
BTRVID
BTRCALL
BTRCALLID
BTRVEX
BTRVEXID
Obsolete Functions
Btrieve API Function Parameters
Operation Code
Status Code
Position Block
Data Buffer
Data Buffer Length
Key Buffer
Key Number
Client ID
Key Length
Summary of Btrieve API Operations
Session-Specific Operations
File-Specific Operations
Unsupported Operations
Sequence of Events in Performing a Btrieve API Operation
Btrieve API Operations
Abort Transaction (21)
Parameters
Prerequisites
Procedure
Result
Positioning
Begin Transaction (19 or 1019)
Parameters
Prerequisites
Procedure
Result
Positioning
Clear Owner (30)
Parameters
Prerequisites
Procedure
Result
Positioning
Close (1)
Parameters
Prerequisites
Procedure
Result
Positioning
Continuous Operation (42)
Parameters
Procedure
Details
Result
Positioning
Create (14)
Parameters
Prerequisites
Procedure
Details
File Specification Block
Key Specification Block
Alternate Collating Sequence
Data Buffer Length
Key Number
Delete and Rename Subfunctions for the Create Operation
Notes on Rename and Delete Subfunctions
Result
Positioning
Create Index (31)
Parameters
Prerequisites
Procedure
Details
Result
Positioning
Delete (4)
Parameters
Prerequisites
Procedure
Details
Result
Positioning
Drop Index (32)
Parameters
Prerequisites
Procedure
Details
Result
Positioning
End Transaction (20)
Parameters
Prerequisites
Procedure
Result
Positioning
Find Percentage (45)
Parameters
Prerequisites
Procedure
Details
Granularity
Result
Positioning
Get By Percentage (44)
Parameters
Prerequisites
Procedure
Details
Granularity
Result
Positioning
Get Direct/Chunk (23)
Parameters
Prerequisites
Procedure
Details
Random Chunks
Rectangle Chunk Descriptor Structure
Next-in-Record Subfunction Bias
Result
Positioning
Get Direct/Record (23)
Parameters
Prerequisites
Procedure
Result
Positioning
Get Directory (18)
Parameters
Prerequisites
Procedure
Result
Positioning
Get Equal (5)
Parameters
Prerequisites
Procedure
Result
Positioning
Get First (12)
Parameters
Prerequisites
Procedure
Result
Positioning
Get Greater Than (8)
Parameters
Prerequisites
Procedure
Result
Positioning
Get Greater Than or Equal (9)
Parameters
Prerequisites
Procedure
Result
Positioning
Get Key (+50)
Parameters
Prerequisites
Procedure
Result
Positioning
Get Last (13)
Parameters
Prerequisites
Procedure
Result
Positioning
Get Less Than (10)
Parameters
Prerequisites
Procedure
Result
Positioning
Get Less Than or Equal (11)
Parameters
Prerequisites
Procedure
Result
Positioning
Get Next (6)
Parameters
Prerequisites
Procedure
Result
Positioning
Get Next Delete Extended (85)
Parameters
Prerequisites
Procedure
Details
Result
Positioning
Get Next Extended (36)
Parameters
Prerequisites
Procedure
Details
Input Buffer for Extended Operations
Collation of LIKE Results
Using the JSON QUERY Operator
JSON Query Examples
Processing of Logical AND and OR in a Filter
Examples of Filtering Records
Output Buffer for Extended Operations
Result
Positioning
Get Position (22)
Parameter
Prerequisites
Procedure
Result
Positioning
Get Previous (7)
Parameters
Prerequisites
Procedure
Result
Positioning
Get Previous Delete Extended (86)
Parameters
Prerequisites
Procedure
Details
Result
Positioning
Get Previous Extended (37)
Parameters
Prerequisites
Procedure
Details
Result
Positioning
Insert (2)
Parameters
Prerequisites
Procedure
Result
Positioning
Insert Extended (40)
Parameters
Prerequisites
Procedure
Details
Result
Positioning
Login/Logout (78)
Parameters
Prerequisites
Login Procedure
Logout Procedure
Result
Notes
Positioning
Open (0)
Parameters
Prerequisites
Procedure
Details
Result
Positioning
Reset (28)
Parameters
Prerequisites
Procedure
Result
Positioning
Set Directory (17)
Parameters
Prerequisites
Procedure
Result
Positioning
Set Owner (29)
Parameters
Prerequisites
Procedure
Details
Result
Positioning
Stat (15)
Parameters
Prerequisites
Procedure
Details
File Specifications
Key Specifications
Alternate Collating Sequences
Result
Positioning
Stat Extended (65)
Parameters
Prerequisites
Procedure
Subfunction 1: Extended File Information
Input Data Buffer Structure
Output Data Buffer Structure
Subfunction 2: System Data Information
Input Data Buffer Structure
Output Data Buffer Structure
Subfunction 3: Duplicate Record Conflict Information
Input Data Buffer Structure
Output Data Buffer Structure
Subfunction 4: File Information
Input Data Buffer Structure
Output Data Buffer Structure
Subfunction 5: Gateway Information
Input Data Buffer Structure
Output Data Buffer Structure
Subfunction 6: Lock Owner Identification
Input Data Buffer Structure
Output Data Buffer Structure
Subfunction 7: Security Information
Input Data Buffer Structure
Output Data Buffer Structure
Subfunction 8: Listing of Table or File Name Causing a Status Code 71
Input Data Buffer Structure
Output Data Buffer Structure
Result
Step First (33)
Parameters
Prerequisites
Procedure
Result
Positioning
Step Last (34)
Parameters
Prerequisites
Procedure
Result
Positioning
Step Next (24)
Parameters
Prerequisites
Procedure
Result
Positioning
Step Next Extended (38)
Parameters
Prerequisites
Procedure
Details
Result
Positioning
Step Next Delete Extended (87)
Parameters
Prerequisites
Procedure
Details
Result
Positioning
Step Previous (35)
Parameters
Prerequisites
Procedure
Result
Positioning
Step Previous Delete Extended (88)
Parameters
Prerequisites
Procedure
Details
Result
Positioning
Step Previous Extended (39)
Parameters
Prerequisites
Procedure
Details
Result
Positioning
Stop (25)
Parameters
Procedure
Result
Positioning
Unlock (27)
Parameters
Prerequisites
Procedure
Result
Positioning
Update (3)
Parameters
Prerequisites
Procedure
Result
Positioning
Update Chunk (53)
Parameters
Prerequisites
Procedure
Details
Random Chunk Descriptor Structure
Rectangle Chunk Descriptor Structure
Truncate Descriptor Structure
Next-in-Record Subfunction Bias
Append Subfunction Bias
Result
Positioning
Version (26)
Parameters
Prerequisites
Procedure
Result
Positioning
Quick Reference of Btrieve Operations
Table of Btrieve API Operations
About This Document
Quick Reference of Btrieve Operations
This site works best with JavaScript enabled