xref: /original-bsd/usr.bin/tn3270/api/README (revision a9c19d04)
1apilib/
2
3The files in this directory are not part of tn3270 proper.
4
5They provide a C interface to the 3270 Applications Programming
6Interface (API) provided by tn3270.
7
8This interface is modeled after (and supposed to be compatible
9with) the "low level" API provided with IBM's 3270 PC control
10program version 3.  Note that we only provide a subset of the
11API functionality.  This subset is (again supposed to be) consistent
12with that subset provided by the IBM PC 3270 Emulation Program
13version 3.00.  This subset is (somewhat sketchily) documented
14in Volume 4, Number 4 of the IBM Personal Computer Proceedings.
15The 3270 PC API itself is documented in SA23-0221 (I have revision
16-01) "IBM 3270 Personal Computer Control Program -- Programming
17Guide".
18
19The INTENT is to allow the API from both MSDOS and from Unix.  Note,
20however, that at the current time only MSDOS is supported.
21
22Now, to program:
23
24First, call "api_init()".  If it returns "1", then all is OK.  If
25it returns "0", then the API is not active.
26
27From then on, call whatever seems right.
28
29You will need to include "../ctlr/oia.h" and "../api/api.h", at a
30minimum.
31