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