home *** CD-ROM | disk | FTP | other *** search
/ ftp.rarlab.com / 2014.05.ftp.rarlab.com.tar / ftp.rarlab.com / rar / TDFUnRar.zip / Readme.txt < prev   
Text File  |  2003-03-05  |  5KB  |  156 lines
  1. For more comments look in the source and the file UNRARDLL.TXT
  2. which is included in the UnRar.dll-Distribution-File.
  3.  
  4. There's no special Form-File for Password- and Volumn-Dialogs. The
  5. Dialogs are created dynamicly in the DFUnRar-Unit.
  6.  
  7.  
  8. /****************
  9. The unit untUnRar.pas contains the constants, records and
  10. functions for using the unrar.dll
  11.  
  12. To Create english messages delete the comments for the
  13. constants (and translate in better english)
  14. ****************/
  15. untUnRar.pas
  16.  
  17. // Loads UnRar.dll - Dll must be in the standard-Dll-Paths
  18. procedure LoadRarLibrary;
  19.  
  20. // Unloading UnRar.dll
  21. procedure UnLoadRarLibrary;
  22.  
  23. // returns true, if dll is loaded, otherwise false
  24. function  IsRarLoaded: boolean;
  25.  
  26.  
  27. /****************
  28. The unit DFUnRar.pas contains a component for easy using the unrar.dll
  29. Limitations: 
  30. - dont uses the extended Data-Structures and functions
  31. ****************/
  32.  
  33. /** Enumerations
  34.  
  35. // Used for property >Mode<
  36. TDFRarMode = (DFRAR_EXTRACT, DFRAR_LIST);
  37.  
  38. // Uses for Status Messages in the event OnStatus
  39. TRarStatus = (RAR_ONOPEN, RAR_ONBEFOREOPEN, RAR_ONEXTRACTFILE, RAR_AFTERCLOSE, RAR_ONPASSWORD);
  40.  
  41. // Override Options for overriding files
  42. TOverrideOptions = (OR_ALWAYS, OR_NEVER, OR_EVENT);
  43.  
  44.  
  45. /** Data Structures
  46.   TDFRARHeaderData = record
  47.     ArchiveName         : string;    // Archiv-Name
  48.     FileName            : string;    // FileName in Archiv with relativ Path
  49.     FlagContinueNextVol : boolean;   // the rest of the File are in the next volumn
  50.     FlagContinuePrevVol : boolean;   // the rest of the File are in the previous volumn
  51.     FlagNeedPassword    : boolean;   // you need a password to extract this file
  52.     IsDirectory         : boolean;   // this is a directory entry
  53.     DictionarySize      : Integer;   // size of the dictionary (not used here)
  54.     PackSize            : cardinal;  // packed filesize
  55.     UnpSize             : cardinal;  // unpacked filesize
  56.     HostOS              : string;    // Name of Host Operation System
  57.     FileCRC             : string;    // CRC-Code of File as 'F4F5F6F7'
  58.     FileTime            : TDateTime; // FileTime
  59.     MajorVersionNeeded  : Cardinal;  // Major Version needed to extract a file (not used here !!)
  60.     MinorVersionNeeded  : Cardinal;  // Minor Version needed to extract a file (not used here !!)
  61.     Method              : string;    // Compress Method - see constants in untUnRar.pas - COMPRESSMETHODxxxxx
  62.     FAArchive           : boolean;   // FileAttribut Archiv is set
  63.     FACompressed        : boolean;   // FileAttribut compressed is set
  64.     FADirectory         : boolean;   // FileAttribut directory is set
  65.     FAHidden            : boolean;   // FileAttribut hidden is set
  66.     FANormal            : boolean;   // FileAttribut normal is set
  67.     FAOffLine           : boolean;   // FileAttribut Offline is set
  68.     FAReadOnly          : boolean;   // FileAttribut Readonly is set
  69.     FASystem            : boolean;   // FileAttribut System is set
  70.     FATempporary        : boolean;   // FileAttribut Temp is set
  71.   end;
  72.  
  73.  
  74. /** Functions
  75.  
  76. // extract or list archive content
  77. procedure   Extract;
  78. // returns false if any erros occours
  79. function    Test: boolean;
  80.  
  81.  
  82. /** Properties
  83. ArchivComment:
  84. - Archiv-Comment
  85. - read only 
  86. - y can also use OnComment-Event 
  87.  
  88. CanProgress: 
  89. - use OnProgress Event
  90. - additional UnRar to calculate filecount and size of all files - slower
  91.  
  92. CommentSize: 
  93. - size of Archive Comment
  94. - read only
  95.  
  96. Directory: 
  97. - target directory for extracting
  98.  
  99. DllVersion: 
  100. - gets the Dll-Versionnumber
  101. - y have to check this with the Major- and Minorversion of the archive
  102. - I dont check this in this release of the component !!
  103.  
  104. FileList: 
  105. - if not empty then only the files are extract which are in this list
  106.  
  107. FileName: 
  108. - Archive-FileName
  109.  
  110. Mode: 
  111. - Open-Mode
  112. - List: List only the content of the archive
  113. - you can use the Event OnFileProcessing for Informations
  114.  
  115. OverrideEvent: 
  116. - if a file exists and you use the property: OR_EVENT this event fires
  117.  
  118. Password: 
  119. - password for archive
  120.  
  121. PromptForPass: 
  122. - use build in password-dialog
  123.  
  124. PromptForVolumn: 
  125. - use build in volumn-dialog
  126.  
  127. StopProcessing: 
  128. - set to true if you want to stop extracting/listing
  129.  
  130.  
  131. /** Events
  132. OnComment: 
  133. - fires on the Archive Comment
  134.  
  135. OnError: 
  136. - fires on Error - mostly the operation or not stopped
  137. - use for stopping StopProcessing-Property
  138.  
  139. OnFileProcessing: 
  140. - use this to get Information for a file to extract/list
  141.  
  142. OnOverride: 
  143. - fires if a file already exists and y specify the OR_EVENT-Flag
  144.  
  145. OnPassword: 
  146. - fires if a pass is needed
  147.  
  148. OnProgress: 
  149. - fires if y set Property CanProgress
  150.  
  151. OnRarStatus: 
  152. - fires on all status events which are defined in the component
  153.  
  154. OnVolChange: 
  155. - fires if UnRar.dll cant find a volumn on a multi volumn-archive
  156.