Btrieve API Operations
This chapter describes the operations your application can perform using the Btrieve API. For each operation, this chapter presents the following information:
•
Name, code, and description of the operation.
•
Parameters—a table indicating which of the six parameter values the operation expects from and returns to your application. A “Sent” parameter is sent from the application to the operation; a “Returned” parameter is returned from the operation to the application when the operation is complete.
•
Prerequisites—the conditions your application must satisfy for the operation to be successful.
•
Procedure—the steps for initializing the parameters that the operation requires.
•
Details—additional information about the operation.
•
Result—the results of both a successful and an unsuccessful operation. Each operation returns a status code, informing your application of the outcome of the operation. Status Code 0 indicates the operation was successful. A nonzero status code usually indicates a failure. However, some nonzero status codes are informative and appear even when the associated operation is successful—for example, Status Code 60 means the specified reject count has been reached.
•
Positioning—the effect the operation has on the logical and/or physical currency of the records in a file.
This chapter includes the following Btrieve API operations, organized alphabetically:
•
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 Key (+50)
•
Get Last (13)
•
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)
•
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)