home *** CD-ROM | disk | FTP | other *** search
/ Amiga ISO Collection / AmigaUtilCD1.iso / Editor / GED403R.LZX / Install / Install.run / GOLDEDDATA / developer / api / autodoc / apilib.doc
Encoding:
Text File  |  1996-06-28  |  2.3 KB  |  85 lines
  1. TABLE OF CONTENTS
  2.  
  3. apilib.library/APIMountClient
  4. apilib.library/APICloseClient
  5. apilib.library/APIBriefClient
  6.  
  7. apilib.library/APIMountClient             apilib.library/APIMountClient
  8.  
  9.     NAME
  10.         APIMountClient - start scanner
  11.  
  12.     SYNOPSIS
  13.         description = APIMountClient(apiMsg, args)
  14.  
  15.         struct APIClient *description = APIMountClient(struct APIMessage *, char *)
  16.                D0                                                  A0            A1
  17.     FUNCTION
  18.         This function is called by the host application once for each of its
  19.         instances (e.g. windows) interested in using the client. The client
  20.         is expected to return a client description (may include a container
  21.         request) or NULL to signal an error. The client description is used
  22.         as handle during all subsequent client calls.
  23.  
  24.     INPUTS
  25.         apiMsg  - API message
  26.         args    - additional arguments or NULL
  27.  
  28.     RESULTS
  29.         client description or NULL
  30.  
  31.     SEE ALSO
  32.         APIFlushClient
  33.     BUGS
  34.  
  35. apilib.library/APICloseClient             apilib.library/APICloseClient
  36.  
  37.     NAME
  38.         APICloseClient - Announce removal of an instance using the client
  39.  
  40.     SYNOPSIS
  41.         APICloseClient(handle, apiMsg)
  42.  
  43.         void CloseClient(struct APIClient *, struct APIMessage *)
  44.                 D0                  A0                   A1
  45.  
  46.     FUNCTION
  47.         This function is called by the host application if a host instance
  48.         (e.g. a window) using the client is terminated. The client is supposed
  49.         to free ressources related to that instance.
  50.  
  51.     INPUTS
  52.         handle - handle obtained by APIMountClient()
  53.         apiMsg - API message
  54.  
  55.     RESULTS
  56.  
  57.     SEE ALSO
  58.         APIMountClient
  59.  
  60.     BUGS
  61.  
  62. apilib.library/APIBriefClient             apilib.library/APIBriefClient
  63.  
  64.     NAME
  65.         APIBriefClient - notify client
  66.  
  67.     SYNOPSIS
  68.         APIBriefClient(handle, apiMsg)
  69.  
  70.         void APIBriefClient(struct APIClient *, struct APIMessage *)
  71.                                  A0                      A1
  72.     FUNCTION
  73.         This function is called to pass commands to a client. The client
  74.         is expected to set the result slots of <apiMsg>.
  75.  
  76.     INPUTS
  77.         handle - handle obtained by APIMountClient()
  78.         apiMsg - API message
  79.  
  80.     RESULTS
  81.  
  82.     SEE ALSO
  83.  
  84.     BUGS
  85.