Compsee Apex III, Техническое справочное руководство

Страница: 85 / 168

Apex PDT Technical Reference Manual 6 Utility Programs
COAM30002 Rev. 2.00 8/13/02
6-13
High-Level API (C, C++ Language)
Only one header file, [bc_api.h] (supplied) is required to use the
C/C++ API. This file is well documented and serves as its own
reference. It is strongly recommended that the user always include
this file in applications that use the API library. It is suitable for
inclusion in programs written in C or C++.
Install Check
BcApiInstallCheck
Syntax:
bool BcApiInstallCheck(unsigned char id)
Input: id = driver’s multiplex ID, usually BCD_ID (0CEh)
Returns: True if driver installed, else false.
Notes: This function is used to determine if the driver is installed.
If not installed, the application should
exit() , returning an
error code (non-zero) to DOS. Since it is expected that the
application would require the driver, this error is
unrecoverable from within the application.
Set Options
BcApiSetOption
Syntax:
int BcApiSetOption(unsigned char id, char far *s)
Input: id = driver’s multiplex ID, usually BCD_ID (0CEh)
s = (far) pointer to ASCIIZ string
Returns: 0 for success
BAD_OPTION, BAD_MOD1, BAD_MOD2 indicating
which part of the string failed parsing.
Notes: This function is used to pass options and modifiers to the
driver using the same syntax as the command line
interface.
Unlike the command line, only one option (and its
modifiers) can be passed as a string argument at a time.
Multiple options will result in the driver’s failure to
process the string option.