xref: /csrg-svn/usr.bin/tn3270/api/README (revision 36284)
1*31204Sminshallapilib/
2*31204Sminshall
3*31204SminshallThe files in this directory are not part of tn3270 proper.
4*31204Sminshall
5*31204SminshallThey provide a C interface to the 3270 Applications Programming
6*31204SminshallInterface (API) provided by tn3270.
7*31204Sminshall
8*31204SminshallThis interface is modeled after (and supposed to be compatible
9*31204Sminshallwith) the "low level" API provided with IBM's 3270 PC control
10*31204Sminshallprogram version 3.  Note that we only provide a subset of the
11*31204SminshallAPI functionality.  This subset is (again supposed to be) consistent
12*31204Sminshallwith that subset provided by the IBM PC 3270 Emulation Program
13*31204Sminshallversion 3.00.  This subset is (somewhat sketchily) documented
14*31204Sminshallin Volume 4, Number 4 of the IBM Personal Computer Proceedings.
15*31204SminshallThe 3270 PC API itself is documented in SA23-0221 (I have revision
16*31204Sminshall-01) "IBM 3270 Personal Computer Control Program -- Programming
17*31204SminshallGuide".
18*31204Sminshall
19*31204SminshallThe INTENT is to allow the API from both MSDOS and from Unix.  Note,
20*31204Sminshallhowever, that at the current time only MSDOS is supported.
21*31204Sminshall
22*31204SminshallNow, to program:
23*31204Sminshall
24*31204SminshallFirst, call "api_init()".  If it returns "1", then all is OK.  If
25*31204Sminshallit returns "0", then the API is not active.
26*31204Sminshall
27*31204SminshallFrom then on, call whatever seems right.
28*31204Sminshall
29*31204SminshallYou will need to include "../ctlr/oia.h" and "../api/api.h", at a
30*31204Sminshallminimum.
31