home *** CD-ROM | disk | FTP | other *** search
/ CD Direkt 1995 #3 / _.ISO / cdd / winanw / lhctk / api.txt next >
Text File  |  1994-09-26  |  5KB  |  121 lines
  1. -----------------------------------------------------------------------
  2. int FAR PASCAL Lha(LPSTR szCmdLine, LPSTR szOutput, WORD wSize)
  3. -----------------------------------------------------------------------
  4. Description:    Compress/Decompress file
  5. Parameter:
  6.     szCmdLine    Command string to pass to LHA.DLL.
  7.             Same as DOS LHA command line.
  8.     szOutput    Buffer to return LHA.DLL output.
  9.             Similar to standard output in DOS.
  10.     wSize        Size of szOutput
  11. Return value:
  12.     0         No error
  13.     other value    Error code
  14.  
  15. -----------------------------------------------------------------------
  16. WORD FAR PASCAL GetLhaVersion(void);
  17. -----------------------------------------------------------------------
  18. Description:    Return current LHA.DLL version information
  19. Return value:
  20.     100    Version 1.00 (current version)
  21.     101    Version 1.01
  22.      .
  23.      .
  24.      .
  25. Warning:
  26.     It is recommended that version be checked before using LHA.DLL.
  27.  
  28. -----------------------------------------------------------------------
  29. BOOL FAR PASCAL LhaGetRunning(void)
  30. -----------------------------------------------------------------------
  31. Description:    Check if LHA.DLL is currently running.
  32.         Current version of LHA.DLL does not support multiprocessing.
  33. Return Value:
  34.     TRUE    LHA.DLL is already running.
  35.     FALSE    LHA.DLL is not yet running.
  36. Warning:
  37.     It is recommended that programs check to see if LHA.DLL is already
  38.     running before executing LHA.DLL.
  39.  
  40. -----------------------------------------------------------------------
  41. BOOL FAR PASCAL LhaGetBackGroundMode(void)
  42. -----------------------------------------------------------------------
  43. Description:    Test if LHA.DLL is running in background.
  44. Return Value:
  45.     TRUE    Is running in background
  46.     FALSE    Is not running in background
  47.  
  48. -----------------------------------------------------------------------
  49. BOOL FAR PASCAL LhaSetBackGroundMode(BOOL BackGroundMode);
  50. -----------------------------------------------------------------------
  51. Description:    Set LHA.DLL to run in background mode.
  52.         LHA.DLL will compress/decompress file faster in foreground
  53.         mode, but does not permit multi-processing.
  54. Parameter:
  55.     TRUE    Run LHA.DLL in background mode
  56.     FALSE    Do not run LHA.DLL in background
  57. Return Value:
  58.     TRUE    No error
  59.     FALSE    Unable to change mode or parameter error.
  60. Warning:
  61.     To maintain compatibility between version 1.0x, please turn off
  62.     background mode:
  63.         LhaSetBackGroundMode(FALSE);
  64.  
  65. -----------------------------------------------------------------------
  66. BOOL FAR PASCAL LhaGetCursorMode(void)
  67. -----------------------------------------------------------------------
  68. Description:    Test whether to display cursor when LHA.DLL is running.
  69. Return Value:
  70.     TRUE    Display cursor
  71.     FALSE    Do not display cursor
  72.  
  73. -----------------------------------------------------------------------
  74. BOOL FAR PASCAL LhaSetCursorMode(BOOL CursorMode);
  75. -----------------------------------------------------------------------
  76. Description:    Set LHA.DLL to either display or not display cursor
  77. Parameter:
  78.     TRUE    Display cursor
  79.     FALSE    Do not display cursor
  80. Return Value:
  81.     TRUE    No error
  82.     FALSE    Unable to change mode or parameter error
  83. Warning:
  84.     To maintain compatibility between version 1.0x, please display
  85.     cursor:
  86.         LhaSetCursorMode(TRUE);
  87.     However, if you are running LHA.DLL in the background mode,
  88.     turn of the cursor:
  89.         LhaSetCursorMode(FALSE);
  90.  
  91. -----------------------------------------------------------------------
  92. unsigned int FAR PASCAL GetCursorInterval(void);
  93. -----------------------------------------------------------------------
  94. Description:    Return cursor revolution speed
  95. Return Value:
  96.     Cursor revolution speed in msec
  97.  
  98. -----------------------------------------------------------------------
  99. BOOL FAR PASCAL SetCursorInterval(unsigned int Interval);
  100. -----------------------------------------------------------------------
  101. Description:    Set cursor revolution speed.
  102.         Unable to change value when LHA.DLL is currently running.
  103. Parameter:
  104.     Cursor revolution speed (msec)
  105.     Default value is 80 msec.
  106. Return Value:
  107.     TRUE    No error
  108.     FALSE    LHA.DLL is currently running and cannot change value
  109.  
  110. -----------------------------------------------------------------------
  111. Lha() Error Codes
  112. -----------------------------------------------------------------------
  113. ERROR_ALREADY_RUNNING
  114.     LHA.DLL is alreadying running
  115.  
  116. -----------------------------------------------------------------------
  117. Warnings
  118. -----------------------------------------------------------------------
  119. Following functions will no longer be supported:
  120. ü@    BOOL FAR PASCAL Wait(void)
  121. ü@ü@    BOOL FAR PASCAL Reset(void)