|
<< Click to Display Table of Contents >> Syntax conventions |
  
|
|
<< Click to Display Table of Contents >> Syntax conventions |
|
The C syntax for BDE function calls is:
DBIResult DBIFN DbiFunctionName (argument1, argument2, argument3
...);
Each function definition includes the elements described in this table:
Element |
Description |
Function name |
Name of function |
Examples buttons |
Click to display a window of code examples (either C or Delphi) that you can copy and paste into your application. |
Description |
Summary description of function |
Syntax |
Diagram of the function and parameters in both C and Delphi coding styles. |
Parameters |
Descriptions of each parameter |
Usage |
Detailed information about using the function |
Prerequisites |
State required before function is called |
Completion state |
State after the function completes |
DBIResult return values |
Description of possible values returned after the function completes, if any |
See Also |
Cross references to other related functions |
Each function definition observes these typographical conventions:
Convention |
Purpose |
Example |
Courier font |
Keywords that must be typed |
DBIResult DBIFN DbiInit(); exactly as they appear when used (case-sensitive). |
italic |
Variables and parameters passed |
(hCursor, piRecords, pBuf) to the function, returned from the function, or both. |
[ ] |
Brackets enclose optional |
iPosOffset, [eLock] parameters. Optional parameters can be set to NULL. |
