home *** CD-ROM | disk | FTP | other *** search
/ Shareware Overload / ShartewareOverload.cdr / progm / flash-c1.zip / CH1_1.DOC < prev    next >
Text File  |  1990-02-11  |  4KB  |  122 lines
  1. ■ INTRODUCTION
  2.  
  3.   This is a reference manual for the FlashPac C library. This
  4.   implementation is for use with Microsoft or Turbo C in the PC-DOS
  5.   operating system.  A working knowledge of C and personal computers
  6.   is assumed.
  7.  
  8.   The routines that are included here were created to provide a
  9.   programmer with low level routines that access the video display,
  10.   keyboard, printer, disk, and mouse devices.  These routines are not
  11.   intended to replace the standard features of C.  They were created
  12.   to add to and extend to the C programming environment for MS-DOS and
  13.   PC-DOS operating systems.
  14.  
  15.   In order to lessen the confusion of using these routines the number
  16.   of global variables needed for use with this library has been kept
  17.   to a minimum.  All the functions in the library were written in
  18.   assembly language using the pascal parameter passing conventions.
  19.  
  20.   The library contains routines for the disk, keyboard, mouse, printer
  21.   and video display devices, as well as a couple of DOS functions.
  22.   The header file FPCLIB.H contains all of the function and variable
  23.   declarations needed for this library.
  24.  
  25.   DISK       Supports several DOS function calls that use byte streams
  26.              when accessing disk files.
  27.  
  28.   GETKEY     Required for EditSt.
  29.  
  30.   KBD        Supports BIOS and DOS keyboard function calls.
  31.  
  32.   MOUSE      Supports basic mouse functions, including a mouse event
  33.              handler.
  34.  
  35.   PRT        Support BIOS printer functions.
  36.  
  37.   VIDEO      Several video routines that provide direct access to the
  38.              video display.  Routines include saving and restoring the
  39.              screen, framing windows, setting the absolute position of
  40.              the cursor, etc.
  41. ..page
  42. ■ Installation
  43.  
  44.   The FlashPac C library consists of two files:
  45.  
  46.      ■ FPCLIB.H
  47.      ■ FPCLIB.LIB
  48.  
  49.   Place the header file "FPCLIB.H" in the same subdirectory that
  50.   contains your other header files and place "FPCLIB.LIB" into the
  51.   same subdirectory that your other library files are in.  You are now
  52.   ready to use the FlashPac C library.
  53.  
  54.  
  55. ■ Compiling and Linking a test program
  56.  
  57.   To compile and link "DEMO.C" and "GETKEY.C" modules use the
  58.   instructions for the appropriate compiler.
  59.  
  60. ■ Turbo C:
  61.  
  62.   Integrated environment:
  63.  
  64.       1. Select the large memory model under the Options, compiler
  65.          menu.
  66.       2. Create a project file with the following three lines:
  67.             demo    (demo.c)
  68.             getkey  (getkey.c)
  69.             fpclib.lib
  70.       3. Select the project file under the compile menu option select
  71.          build all to create an executable file called demo.exe
  72.  
  73.  
  74.   Command Line:
  75.  
  76.       C>tcc -IC:\INC -LC:\lib -ml demo.c getkey.c \lib\fpclib.lib
  77.  
  78.       -IC:\INC    C:\INC is the include subdirectory for header files
  79.       -LC:\LIB    C:\LIB is the library subdirctory for Turbo C
  80.                   libraries
  81.       -ml         selects large memory model
  82.       \lib        is the subdirectory where fpclib.lib is located
  83.  
  84.  
  85. ■ Microsoft C:
  86.  
  87.   C>cl /AL /F 4000 demo.c getkey.c \lib\fpclib.lib
  88.  
  89.       /AL         selects large memory model
  90.       /F 4000     create an 16K stack area
  91.       \lib        is the subdirectory where fpclib.lib is located
  92. ..page
  93. ..head02L----------------------------------------------------------------------
  94. ..head04L----------------------------------------------------------------------
  95. ..head03ASample
  96. ■ Description
  97.  
  98.   What the function does
  99.  
  100.  
  101. ■ Summary
  102.  
  103.   Function declaration with parameter list.
  104.   Parm1       Parm1 description.
  105.   Parm2       Parm2 description.
  106.  
  107.  
  108. ■ Remarks
  109.  
  110.   General comments.
  111.  
  112.  
  113. ■ See Also
  114.  
  115.   Related functions
  116.  
  117.  
  118. ■ Example
  119.  
  120.   Sample program or code fragment.
  121. ..page
  122.