Properties
aspEasyZip object
Last modified : September 3, 2001 
© 2001 MITData. All rights reserved.
Properties

 

Name Description
ZipFileName You must specified the name of the file to Zip or UnZIp. ( with full path )
returns a WideString - Read / Write
Version Returns de version of the component and the version of the zip / unzip libraries
returns a WideString - Read only
Debug Sets the component in debug mode, when you made any operation then it displays on the screen. Default is set to False.
returns a WordBool - Read / Write
ExtrBaseDir This base directory applies only to ‘UnZIP’ operations. The component will make this directory the current directory before extracting any files. If you don't specify a value for this property, then the directory of the ZipFile itself will be the base directory for extractions.
SuccessCNT Number of files that were successfully operated when you call ZIP or UNZIP method.
returns an Integer - Read only
Error Number of the error when you call the ZIP or UNZIP method, it return 0 for no errors
returns an Integer - Read only
List of comom errors:
-1 File not found
2 Unexpected end of file
3 Invalid structure of Zip file
4 Out of memory
5 Internal error
6 Tempory file error ( check write permissions )
10 Tempory file error ( check write permissions )
11 Error reading file
13 Missing Zip File or unable to write zip ( check permissions on the INET_xxxx user )
14 Error writting to the a file
15 Error creating a file
16 Bad zip option specified ( check the addOption )
17 File not found or not read permissions
LastMessage
1.01		 Returns the explanation  of the last action, if you get an error on the last action performed then you will get a brief explanation with that function of what happened.
returns a String - Read only
Version 2.0 properties
AddOptions
2.0		 AddOptions is a Set of options to modify the default action of the Add method.

Example: Zip.AddOptions = AddDirNames + AddRecurseDirs 
or:          Zip.AddOptions = 1 + 4

AddDirNames ( value = 1 )
Saves the pathname with each filename. 
NOTE: the root directory name is never stored in a pathname; in other words, the first character of a pathname stored in the zip file's directory will never be a slash.

AddZipTime ( value = 2 )
Set Zip timestamp to that of the newest file in the archive.

AddRecurseDirs ( value = 4 )
Subdirectories below EACH given file specification will be included in the Zip archive. 
Defaults to False.
WARNING: This is potentially dangerous if the user does this from the root directory. The hard drive may fill up with a huge Zip file!

AddHiddenFiles ( value = 8 )
Files with their Hidden or System attributes set will be included in the Add operation.

AddEncrypt ( value = 16 )
Add the files with standard zip encryption. You must set the password property. (only professional version)

AddSeparateDirs ( value = 32 )
Add separate entries to the zip archive that will hold the name of each directory from root. (No data for these entries).NOTE: - To use this, you must also have AddDirNames set.

AddMove ( value = 256 )
After adding to archive, delete original file. Potentially dangerous. Use with caution!
NOTE: Freshen and Update can only work on pre-existing archives. Update can add new files to the archive, but can’t create a new archive.

AddFreshen ( value = 1024 )
Add newer files to archive (only for files that are already in the archive).

AddUpdate ( value = 2048 )
Add newer files to archive (but, any file in an file specification that isn't already in the archive will also be added).

returns/set an Integer - Read / Write
ExtrOptions
2.0		 ExtrOptions is a Set of Options used to modify the default actions of the Extract method.

ExtrDirNames ( value = 1 )
Extracts and recreates the relative pathname that may have been stored with each file. Empty directories stored in the archive (if any) will also be recreated.

ExtrOverWrite ( value = 2 )
Overwrite any pre-existing files during Extraction.

ExtrFreshen ( value = 4 )
Extract newer files from archive (only for files that already exist). Won't extract any file that isn't already present.

ExtrUpdate ( value = 8 )
Extract files that don’t already exist and if ExtrOverWrite is also set to true, it will extract newer files from the archive.

ExtrTest ( value = 16 )
Only test the archive to see if the files could be successfully extracted. Testing is done by extracting the files, but NOT writing the extracted data to the disk. 

returns/set an Integer - Read / Write
NVersion
2.0		 Returns de version of the component.
returns a Integer - Read only
Version 2.1 properties
Temp
2.1		 Temp is the path and directory that will be used instead of the default temporary directory. The default temporary directory when zipping and unzipping is the same directory as where the zipfile is located.

Remember to set write permissions to the directory 

returns/set a String - Read / Write
Version 2.2 ( 09/01/2001) properties
RootDir
2.2		 RootDir sets the base directory for relative path file specifications.

The RootDir property determines where zipping will start for any filenames or wildcard entries in the ArgsAdd method.

Example:

Zip.RootDir  = "D:\Program Files\Start"
Zip.ArgsAdd( "Dir1\MyFile.html")
Zip.ArgsAdd("‘*.h") 
Zip.Add;

This will add the file “D:\Program Files\Start\Dir1\MyFile.htm” as “Dir1\MyFile.html” and all files “D:\Program Files\Start\*.h” as “*.h” to the zip archive.

returns/set a String - Read / Write
Version 2.0 properties  ( PROFESSIONAL )
Password
2.0		 Password is the password used when encrypting or decrypting a Zip archive. It must be set before using any method.
sets a String - Write Only
SFXCaption
2.0		 Is the caption of the SFX dialog box when you start executing a .EXE archive.
sets a String - Write Only
SFXCommandLine
2.0		 Can contain a command line to execute after extracting the executable.

Special symbols:
| (Vertical bar) is the command / argument separator.
>< Is the actual extraction directory selected by user.

Example: notepad.exe|><Readme.txt
This will run notepad to show "Readme.txt" in the actual extraction dir.
sets a String - Write Only
SFXDefaultDir
2.0		 The directory that will be used by the executable when extracting.

If you specify the special symbol >< here, then the user’s temporary 
directory will be the default extraction directory. 
sets a String - Write Only
SFXOptions
2.0		 Set of options used to modify the default actions of the ConvertSFX method.

SFXAskCmdLine ( value = 1 )
Allows user (at runtime) to de-select the SFX program’s command line checkbox. Once de-selected, the command line will not be executed.
NOTE: The checkbox doesn't appear unless there is a command line specified.

SFXAskFiles ( value = 2 )
Lets user (at runtime) modify the SFX program's list of files to be extracted.

SFXAutoRun ( value = 4 )
Extraction of the SFX contents will be performed automatically, no user actions are required.
NOTE: This works only if the SFX's filename starts with an exclamation mark ( ! ) -for security reasons-For example: !AUTORUN.EXE
WARNING: Use this only in rare cases! We advise you NOT to use this because files will be extracted onto the user's disk without his knowledge.

SFXCheckSize ( value = 8 )
Then the size of the SFX executable will be checked before extracting. By default checking is set to True. If size checking is off (False) and the SFX file layout is wrong it is very likely you will get a system error.

SFXHideOverWriteBox ( value = 16 )
Does NOT show the user (at runtime) the SFX program’s dialog box that lets him choose the overwrite action for files that already exist.

returns/set an Integer - Read / Write
SFXHideOverWriteBox
2.0		 Sets the the action for what the SFX program is supposed to do if it finds files that already exist.

OvrConfirm ( value = 1 )
 Ask user when each file is found (The default).

OvrAlways ( value = 2 )
 Aways overwrite existing files.

OvrNever ( value = 4 )
 Never overwrite - skip those files.

returns/set an Integer - Read / Write
SFXBinPath
2.32		 Sets the binary file to use when creating exe file, actually the are two version, English and German languages.

returns/set a String - Read / Write