home *** CD-ROM | disk | FTP | other *** search
/ Tricks of the Mac Game Programming Gurus / TricksOfTheMacGameProgrammingGurus.iso / Demos / Tools / QC™ 1.1.3 / QCAPI / QCAPI Reference / QCAPI Reference.rsrc / TEXT_129.txt < prev    next >
Encoding:
Text File  |  1995-04-23  |  2.0 KB  |  35 lines
  1.  
  2. About the API
  3.  
  4. The QC Application Programming Interface (API)can be used to control QC directly from your code during development.  Most of the functions accessible from the QC Control Panel are accessible by using the API.  
  5.  
  6. Using the API requires that the QC extension be loaded during system startup and that your application code link with the library supplied for your development environment.
  7.  
  8.  
  9. Prerequisites
  10.  
  11. This reference manual assumes are you familiar with Macintosh programming and specifically, that you are familiar with Macintosh memory management through the use of Handles and Pointers.  If you are not familiar with basic memory management techniques it is strongly suggested you read the Inside Macintosh volumes pertaining to application runtime and memory management.  This manual assumes the reader is an intermediate to expert Macintosh developer and using this assumption, does not attempt to cover any such development topics.
  12.  
  13.  
  14. Reference format
  15.  
  16. There are multiple sections of this reference for controlling different aspects of QC testing.  The API uses C calling conventions.  Each reference section will contain the following information:
  17.  
  18. Interface    -    The API call and the interface to it.
  19. Description    -    Description of what the call does and why you would use it.
  20. Results    -    Description of possible results and possible errors for the call, but not
  21.                                                             limited to those descibed.
  22.  
  23.  
  24. QC API Libraries
  25.  
  26. Libraries are provided for using the API from MPW, CodeWarrior, and THINK environments.  Simply link these libraries into your projects to access all the calls described in this document.
  27.  
  28. MPW    -    Link with 'QCAPI.o'
  29. CodeWarrior - If building an application, link with 'QCAPI.CWLIB'.  If building a code resource (A4-based), link with 'QCAPI.CWA4LIB'.
  30. THINK    -    If building an application, link with 'QCAPI.LIB'.     If building a code resource (A4-based), link with 'QCAPI.A4LIB'.
  31.  
  32. PowerPC Projects
  33.  
  34. There is a PowerPC shared library called 'QCAPI Lib' that can be used in CodeWarrior, MPW, or Symantec 8.0 projects.
  35.