home *** CD-ROM | disk | FTP | other *** search
/ Aminet 10 / aminetcdnumber101996.iso / Aminet / util / misc / PC_20.lha / PatchControl / autodoc / patch.doc
Text File  |  1995-11-15  |  3KB  |  139 lines
  1. TABLE OF CONTENTS
  2.  
  3. patch.resource/AddChangeHook
  4. patch.resource/FreePatchList
  5. patch.resource/GetPatchList
  6. patch.resource/RemChangeHook
  7. patch.resource/SetPatchMode
  8.  
  9. patch.resource/AddChangeHook                     patch.resource/AddChangeHook
  10.  
  11.    NAME
  12.     AddChangeHook - add a hook for patch notify
  13.  
  14.    SYNOPSIS
  15.     success = AddChangeHook( Hook )
  16.       D0        A0
  17.  
  18.     bool AddChangeHook(APTR);
  19.  
  20.    FUNCTION
  21.     This routine installes a hook to check if a patch was removed or
  22.     added. The hook will be called with a pointer to the hook in A0.
  23.     Please make sure that your hook-routine is fast. The task what sets
  24.     or removes a patch will be locked until your hook-routine returns.
  25.     The best thing is to send a message to your task where you can get a
  26.     new patchlist.
  27.  
  28.     INPUTS
  29.     Hook - standart hookstructure
  30.  
  31.     RESULTS
  32.     success - FALSE or TRUE
  33.  
  34.     BUGS
  35.  
  36.     SEE ALSO
  37.     RemChangeHook()
  38.  
  39. patch.resource/FreePatchList                     patch.resource/FreePatchList
  40.  
  41.    NAME
  42.     FreePatchList - deallocate the list of systempatches
  43.  
  44.    SYNOPSIS
  45.     FreePatchList( PatchList )
  46.               A0
  47.  
  48.     void FreeMiscResource(APTR);
  49.  
  50.    FUNCTION
  51.     This routine frees the PatchList. Please do not free this yourself.
  52.  
  53.     INPUTS
  54.     PatchList - a list of patchnodes
  55.  
  56.     RESULTS
  57.     Frees the appropriate resource.
  58.  
  59.     BUGS
  60.  
  61.     SEE ALSO
  62.     resources/patch.i, GetPatchList(), SetPatchMode()
  63.  
  64. patch.resource/GetPatchList                       patch.resource/GetPatchList
  65.  
  66.     NAME
  67.     GetPatchList - get the list of systempatches
  68.  
  69.    SYNOPSIS
  70.     PatchList = GetPatchList()
  71.     D0
  72.  
  73.     APTR AllocMiscResource();
  74.  
  75.    FUNCTION
  76.     This routine will create a copy of current patchlist. With this copy
  77.     you can work. It have to be freed with FreePatchList().
  78.  
  79.    INPUTS
  80.  
  81.    RESULTS
  82.     PatchList - a list of patchnodes
  83.  
  84.    BUGS
  85.  
  86.    SEE ALSO
  87.     resources/patch.i, FreePatchList(), SetPatchMode()
  88.  
  89. patch.resource/RemChangeHook                     patch.resource/RemChangeHook
  90.  
  91.    NAME
  92.     RemChangeHook - remove a hook for patch notify
  93.  
  94.    SYNOPSIS
  95.     RemChangeHook( Hook )
  96.             A0
  97.  
  98.     void RemChangeHook(APTR);
  99.  
  100.    FUNCTION
  101.     This function removes a hook what's added with AddChangeHook(). Don't
  102.     forget to remove the hook before your program ends.
  103.  
  104.     INPUTS
  105.     Hook - standart hookstructure
  106.  
  107.     RESULTS
  108.  
  109.     BUGS
  110.  
  111.     SEE ALSO
  112.     AddChangeHook()
  113.  
  114. patch.resource/SetPatchMode                       patch.resource/SetPatchMode
  115.  
  116.    NAME
  117.     SetPatchMode - change the mode of a patch
  118.  
  119.    SYNOPSIS
  120.     SetPatchMode( PatchNode, Mode )
  121.             A0      D0
  122.  
  123.     void AddChangeHook(APTR, BOOL);
  124.  
  125.    FUNCTION
  126.     With this routine you can enable or disable a patch.
  127.  
  128.     INPUTS
  129.     PatchNode - a node of a patch
  130.     Mode - 0 = enable and 1 = disable
  131.  
  132.     RESULTS
  133.  
  134.     BUGS
  135.  
  136.     SEE ALSO
  137.     resources/patch.i, GetPatchList(), FreePatchList()
  138.  
  139.