home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / comos2.zip / READ.ME < prev    next >
Text File  |  1993-02-22  |  3KB  |  78 lines
  1. ***  NOTES ON COMMOS2  ***
  2.  
  3. A registration form is included in REGISTER.TXT.
  4.  
  5. *** IOPL Applications ***
  6.  
  7. A sample "DEF" file (IOPL.DEF) is included to demonstrate how to modify 
  8. your DEF file to use the IOPL routines.  You will need to incorporate 
  9. the IOPL statements into your "DEF" file to gain IOPL privilege.
  10.  
  11. The library also contains four routines which provide IOPL services for
  12. an application.  These are indicated under the appropriate section below.
  13.  
  14. *** 16-bit Applications ***
  15.  
  16. Any C code which wishes to make use of these routines should have the
  17. following added to it's header
  18.  
  19. #define INCL_COMMOS2_16BIT
  20. #include "COMMOS2.H"
  21.  
  22. which provides the proper prototypes for the functions.
  23.  
  24. The functions available are:
  25.  
  26.   CommOpen           - Opens a COM port
  27.   CommInit           - Initializes a COM port
  28.   CommClose          - Closes a COM port
  29.   CommClear          - Clears a COM port
  30.   CommWrite          - Writes data to a COM port
  31.   CommRead           - Reads data from a COM port
  32.   CommReadTimeOut    - Reads data from a COM port or times out
  33.   CommReadUntilByte  - Reads data from a COM port until a certain character
  34.                        is received
  35.   CommQueryRxCount   - Returns the number of characters waiting to be read
  36.   CommQueryRxBufSize - Returns the size of the receiver buffer
  37.   CommQueryTxCount   - Returns the number of characters waiting to be sent
  38.   CommQueryTxBufSize - Returns the size of the transmit buffer
  39.   ioplinp            - Reads a port directly to get a single character
  40.   ioplinpw           - Reads a port directly to get a single word
  41.   ioplout            - Writes a single character directly to a port
  42.   ioploutw           - Writes a word directly to a port
  43.  
  44. *** 32-bit Applications ***
  45.  
  46. Any C code which wishes to make use of these routines should have the
  47. following added to it's header
  48.  
  49. #define INCL_COMMOS2_32BIT
  50. #include "COMMOS2.H"
  51.  
  52. which provides the proper prototypes for the functions.
  53.  
  54. The functions available are:
  55.  
  56.   CommOpen           - Opens a COM port
  57.   CommInit           - Initializes a COM port
  58.   CommClose          - Closes a COM port
  59.   CommClear          - Clears a COM port
  60.   CommClearRxBuffer  - Clears the COM port receiver buffer
  61.   CommClearTxBuffer  - Clears the COM port transmit buffer
  62.   CommWrite          - Writes data to a COM port
  63.   CommRead           - Reads data from a COM port
  64.   CommReadTimeOut    - Reads data from a COM port or times out
  65.   CommReadUntilByte  - Reads data from a COM port until a certain character
  66.                        is received
  67.   CommQueryRxCount   - Returns the number of characters waiting to be read
  68.   CommQueryRxBufSize - Returns the size of the receiver buffer
  69.   CommQueryTxCount   - Returns the number of characters waiting to be sent
  70.   CommQueryTxBufSize - Returns the size of the transmit buffer
  71.   PortInpByte        - Reads a port directly to get a single character
  72.   PortInpWord        - Reads a port directly to get a single word
  73.   PortOutByte        - Writes a single character directly to a port
  74.   PortOutWord        - Writes a word directly to a port
  75.  
  76.  
  77.  
  78.