CkZip Python Programming
Reference Documentation

CkZip

Zip compression component.

Object Creation

obj = chilkat.CkZip()

Properties

# pVal is a CkString object (output)
get_AppendFromDir( pVal )

# newVal is a string (input)
put_AppendFromDir( newVal )

When files are added to a Zip archive, they are appended from this directory. For example, if you wish to add all the files under c:/abc/123/myAppDir, you might set this property equal to "c:/abc/123", and then pass "myAppDir/*" to AppendFiles.
Controlling Paths of Files Added to Zip

# pVal is a CkString object (output)
get_AutoRun( pVal )

# newVal is a string (input)
put_AutoRun( newVal )

Optional when creating self-extracting EXEs. This is the name of an executable contained within the to-be-created EXE that will automatically be run after extraction. (This is typically something like "setup.exe")

# pVal is a CkString object (output)
get_AutoRunParams( pVal )

# newVal is a string (input)
put_AutoRunParams( newVal )

Command line parameters that get passed to the AutoRun executable.

# Returns a boolean value
get_AutoTemp( )

# newVal is a boolean (input)
put_AutoTemp( newVal )

This option applies to creating self-extracting EXEs. If True, the to-be-created EXE will automatically select and create a temporary directory for unzipping. This property is often used in conjunction with the AutoRun property to create a self-extracting EXE that automatically unzips to a temp directory and runs a setup.exe without interaction with the user.
Note: To create a self-extracting EXE with no user-interaction, set the following properties to these values:
ExeSilentProgress = False
ExeNoInterface = True
ExeFinishNotifier = False

The default AutoTemp value is False.

# Returns a boolean value
get_CaseSensitive( )

# newVal is a boolean (input)
put_CaseSensitive( newVal )

If True then all methods that get or search for zip entries by name will use case-sensitive filename matching. If False then filename matching will be case insensitive. Methods affected by this property include GetEntryByName, UnzipMatching, FirstMatchingEntry, etc.
The default value is True.

# Returns a boolean value
get_ClearArchiveAttribute( )

# newVal is a boolean (input)
put_ClearArchiveAttribute( newVal )

Set this to True to clear the FILE_ATTRIBUTE_ARCHIVE file attribute of each file during a zipping operation.
The default value is False.

# Returns a boolean value
get_ClearReadOnlyAttr( )

# newVal is a boolean (input)
put_ClearReadOnlyAttr( newVal )

If True, the read-only attribute is automatically cleared when unzipping. The default value of this property is False, which leaves the read-only attribute unchanged when unzipping.

# pVal is a CkString object (output)
get_Comment( pVal )

# newVal is a string (input)
put_Comment( newVal )

The global Zip file comment.

# pVal is a CkString object (output)
get_DecryptPassword( pVal )

# newVal is a string (input)
put_DecryptPassword( newVal )

When opening a password-protected or AES encrypted Zip, this is the password to be used for decryption. Encrypted Zips may be opened without setting a password, but the contents cannot be unzipped without setting this password.
Note:The SetPassword method has the effect of setting both this property as well as the EncryptPassword property. The SetPassword method should no longer be used. It has been replaced by the DecryptPassword and EncryptPassword properties to make it possible to open an encrypted zip and re-write it with a new password.

# Returns a boolean value
get_DiscardPaths( )

# newVal is a boolean (input)
put_DiscardPaths( newVal )

If True, discards all file path information when zipping. The default value is False.

# Returns an integer value
get_EncryptKeyLength( )

# newVal is an integer (input)
put_EncryptKeyLength( newVal )

The encryption key length if AES, Blowfish, Twofish, or WinZip-compatible AES encryption is used. This value must be 128, 192, or 256. The default value is 128.

# pVal is a CkString object (output)
get_EncryptPassword( pVal )

# newVal is a string (input)
put_EncryptPassword( newVal )

The password used when writing a password-protected or strong-encrytped Zip.
Note:The SetPassword method has the effect of setting both this property as well as the DecryptPassword property. The SetPassword method should no longer be used. It has been replaced by the DecryptPassword and EncryptPassword properties to make it possible to open an encrypted zip and re-write it with a new password.

# Returns an integer value
get_Encryption( )

# newVal is an integer (input)
put_Encryption( newVal )

The symmetric encryption algorithm. Valid values are: 0 = none, 1 = blowfish, 2 = twofish, 3 = rijndael (AES), 4 = WinZip compatible AES. When a Zip is encrypted, the directory will still be readable by programs such as WinZip, but the contents, if unzipped, will be encrypted. For modes 1,2, and 3, only applications using Chilkat Zip can decrypt and unzip Zip files created by Chilkat Zip. However, setting this property = 4 produces a WinZip compatible AES encrypted .zip file.
Note:Chilkat implemented strong-encryption prior to WinZip. When modes 1, 2, and 3 were originally implemented, WinZip AES encryption did not yet exist. When WinZip introduced AES encryption, Chilkat added mode 4 to provide the ability to create compatible AES-encrypted zips.
Important:The Encryption and PasswordProtect properties are mutually exclusive. PasswordProtect corresponds to the older Zip 2.0 encryption, commonly referred to as a "password-protected" zip. If the PasswordProtect is set to True, the Encryption property should be set to 0. If the Encryption property is set to a non-zero value, then PasswordProtect should be set to False. A zip cannot be both password-protected and strong-encrypted.

# pVal is a CkString object (output)
get_ExeDefaultDir( pVal )

# newVal is a string (input)
put_ExeDefaultDir( newVal )

Specifies the default unzip directory path to appear in the user-interface dialog box when the self-extracting EXE is run.

# Returns a boolean value
get_ExeFinishNotifier( )

# newVal is a boolean (input)
put_ExeFinishNotifier( newVal )

If set to True, a "Finished" dialog box is displayed when the self-extracting EXE is finished extracting. The caption, title, and button text of the finish notifier dialog may be customized by calling SetExeConfigParam. The default value is False.

# pVal is a CkString object (output)
get_ExeIconFile( pVal )

# newVal is a string (input)
put_ExeIconFile( newVal )

Applies to creating self-extracting EXEs. This property can be set to a pre-existing icon filename (.ico) that will be embedded within the to-be-created EXE and set as its default icon.

# Returns a boolean value
get_ExeNoInterface( )

# newVal is a boolean (input)
put_ExeNoInterface( newVal )

Applies to creating self-extracting EXEs. When set to True, the to-be-created EXE will run without a user-interface. The default value is False.
Note: The ExeSilentProgress property needs to be set to True for the extract to be truly silent.
Important: If the AutoTemp property = True and there is no AutoRun EXE, and there is no ExeUnzipDir set, then the self-extracting EXE will always display a dialog to get the unzip directory. The reason is that it makes no sense to silently unzip to an auto-selected (and unknown) temp directory without anything happening afterwards.
Important: If the self-extracting EXE is encrypted, a password dialog will be displayed. The password dialog may be suppressed if the password is provided on the command line via the -pwd command-line option.

# Returns a boolean value
get_ExeSilentProgress( )

# newVal is a boolean (input)
put_ExeSilentProgress( newVal )

Determines whether a progress dialog is displayed when the self-extracting EXE is run. If ExeNoInterface = False (i.e. there is a main dialog with the ability to select the unzip directory), then the progress dialog is (by default) shown as a progress bar within the main dialog -- and this property has no effect. If ExeNoInterface = True, then a progress-only dialog is displayed if ExeSilentProgress = False. The default value of ExeSilentProgress is True.

# pVal is a CkString object (output)
get_ExeSourceUrl( pVal )

# newVal is a string (input)
put_ExeSourceUrl( newVal )

This property allows you to create a self-extracting EXE where the data to be extracted is not actually contained within the EXE. Instead, when the self-extracting EXE is run, your zip is downloaded from a URL and unzipped. The self-extracting EXE will automatically use the proxy specified by Internet Explorer if one is defined.
In practice, you would prepare your .zip and place it on your web server at a publicly accessible URL. You may then create and distribute self-extracting EXEs that have this URL embedded. Your zip on the web server may be updated at will, and your already-distributed self-extracting EXEs will always download and unzip the latest files.

# pVal is a CkString object (output)
get_ExeTitle( pVal )

# newVal is a string (input)
put_ExeTitle( newVal )

Applies to creating self-extracting EXEs. Sets the title of the main user-interface dialog that appears when the self-extracting EXE runs.

# pVal is a CkString object (output)
get_ExeUnzipCaption( pVal )

# newVal is a string (input)
put_ExeUnzipCaption( newVal )

Applies to creating self-extracting EXEs. Sets the unzipping caption of the main user-interface dialog that appears when the self-extracting EXE runs.

# pVal is a CkString object (output)
get_ExeUnzipDir( pVal )

# newVal is a string (input)
put_ExeUnzipDir( newVal )

Applies to creating self-extracting EXEs. Stores a pre-defined unzip directory within the self-extracting EXE so that it automatically unzips to this directory without user-intervention.
Environment variables may be included if surrounded by percent characters. For example: %TEMP%. Environment variables are expanded (i.e. resolved) when the self-extracting EXE runs.
Note: To create a self-extracting EXE with no user-interaction, set the following properties to these values:
ExeSilentProgress = False
ExeNoInterface = True
ExeFinishNotifier = False

# Returns a boolean value
get_ExeWaitForSetup( )

# newVal is a boolean (input)
put_ExeWaitForSetup( newVal )

If True, the self-extracting EXE will wait for the AutoRun EXE to complete before it exits. If False, the self-extracting EXE dialog (or process if running silently with no user-interface), is allowed to exit prior to the completion of the AutoRun EXE. The default value is True.

# pVal is a CkString object (output)
get_ExeXmlConfig( pVal )

# newVal is a string (input)
put_ExeXmlConfig( newVal )

Allows for an XML config document to be used to specify all possible options for self-extracting EXEs. This property is a string containing the XML config document.

The XML should have this format:

<SfxConfig>
	<ErrPwdTitle>Title for incorrect password dialog</ErrPwdTitle>
	<ErrPwdCaption>Caption for incorrect password dialog</ErrPwdCaption>
	<FinOkBtn>Text on finish notifier button</FinOkBtn>
	<PwdOkBtn>Text on password challenge dialog's "OK" button.</PwdOkBtn>
	<PwdCancelBtn>Text on password challenge dialog's Cancel button.</PwdCancelBtn>
	<ErrInvalidPassword>Incorrect password error message.</ErrInvalidPassword>
	<MainUnzipBtn>Text on main dialog's unzip button</MainUnzipBtn>
	<MainCloseBtn>Text on main dialog's quit/exit button</MainCloseBtn>
	<MainBrowseBtn>Text on main dialog's browse-for-directory button.</MainBrowseBtn>
	<MainUnzipLabel>Caption displayed in main dialog.</MainUnzipLabel>
	<AutoTemp>"1|0"</AutoTemp>
	<ShowFin>"1|0" Maps to ExeFinishNotifier property.</ShowFin>
	<ShowMain>"1|0" Maps to ExeNoInterface property.</ShowMain>
	<ShowProgress>"1|0" Maps to ExeSilentProgress property.</ShowProgress>
	<WaitForSetup>"1|0" Maps to ExeWaitForSetup property.</WaitForSetup>
	<Encryption>"1|0"  1=Yes, 0=No</Encryption>
	<KeyLength>128|192|256</KeyLength>
	<SetupExe>EXE to run after extracting. (Maps to AutoRun property)</SetupExe>
	<UnzipDir>Pre-defined unzip directory. (Maps to ExeUnzipDir property)>
	<DefaultDir>Default unzip directory to appear in the main dialog. 
                                                (Maps to ExeDefaultDir property)</DefaultDir>
	<IconFile>Icon file to be used (Maps to ExeIconFile property)</IconFile>
	<Url>Maps to ExeSourceUrl property.</Url>
	<MainTitle>Maps to ExeTitle property.</MainTitle>
	<MainCaption>Maps to ExeUnzipCaption property.</MainCaption>
	<FinTitle>Title for the finish notifier dialog.</FinTitle>
	<FinCaption>Caption for the finish notifier dialog.</FinTitle>
	<ProgressTitle>Title for the progress dialog.</ProgressTitle>
	<ProgressCaption>Caption for the progress dialog.</ProgressCaption>
	<PwTitle>Title for the password challenge dialog.</PwTitle>
	<PwCaption>Caption for the password challenge dialog.</PwCaption>
</SfxConfig>

# Returns an integer value
get_FileCount( )

The number of files (excluding directories) contained within the Zip.

# pVal is a CkString object (output)
get_FileName( pVal )

# newVal is a string (input)
put_FileName( newVal )

The name of the Zip file. This file is created or overwritten when the Zip is saved.

# Returns a boolean value
get_HasZipFormatErrors( )

True if the opened zip contained file format errors (that were not severe enough to prevent the zip from being opened and parsed).

# Returns a boolean value
get_IgnoreAccessDenied( )

# newVal is a boolean (input)
put_IgnoreAccessDenied( newVal )

If True, then files that cannot be read due to "access denied" (i.e. a file permission error) will be ignored and the call to WriteZip, WriteZipAndClose, WriteExe, etc. will return a success status. If False, then the "access denied" filesystem errors are not ignored and any occurance will cause the zip writing to fail. The default value is True.

# str is a CkString object (output)
LastErrorHtml( str )

Error information in HTML format for the last method called.

# str is a CkString object (output)
LastErrorText( str )

Error information in plain-text format for the last method called.

# str is a CkString object (output)
LastErrorXml( str )

Error information in XML format for the last method called.

# Returns an integer value
get_NumEntries( )

The number of entries in the Zip, including both files and directories.

# Returns an integer value
get_OemCodePage( )

# newVal is an integer (input)
put_OemCodePage( newVal )

Sets the OEM code page to be used for Unicode filenames. This property defaults to the OEM code page of the computer.

# Returns a boolean value
get_OverwriteExisting( )

# newVal is a boolean (input)
put_OverwriteExisting( newVal )

Determines whether existing files are overwritten during unzipping. The default is True, which means that already-existing files will be overwritten. Set this property = False to prevent existing files from being overwritten when unzipping.

# Returns a boolean value
get_PasswordProtect( )

# newVal is a boolean (input)
put_PasswordProtect( newVal )

True if the Zip should be password-protected using older Zip 2.0 encryption, commonly referred to as "password-protection".

# pVal is a CkString object (output)
get_PathPrefix( pVal )

# newVal is a string (input)
put_PathPrefix( newVal )

A prefix that is added to each filename when zipping. One might set the PathPrefix to "subdir/" so that files are unzipped to a specified subdirectory when unzipping.

# pVal is a CkString object (output)
get_Proxy( pVal )

# newVal is a string (input)
put_Proxy( newVal )

(Optional) The name of a proxy to be used with the OpenFromWeb method. Only necessary if your computer uses a proxy to access the Internet. The proxy string should be formatted as "hostname:port", such as "www.chilkatsoft.com:100".

# pVal is a CkString object (output)
get_TempDir( pVal )

# newVal is a string (input)
put_TempDir( newVal )

The temporary directory to use when unzipping files. When running in ASP or ASP.NET, the default value of TempDir is set to the directory where the .zip is being written. Set this property to override the default.

# Returns a boolean value
get_TextFlag( )

# newVal is a boolean (input)
put_TextFlag( newVal )

If set to True, the component will set the "text flag" for each file having these filename extensions: .txt, .xml, .htm, and .html. It will also preserve the "text flag" for existing zips that are opened and rewritten. By default, this property is set to False.
It is generally not necessary to set the text flag for a zip entry.

# Returns a boolean value
get_Utf8( )

# b is a boolean (input)
put_Utf8( b )

When set to true, all "const char *" arguments are expected to be utf-8 strings. If set to false, the "const char *" arguments are expected to be ANSI strings.

# Returns a boolean value
get_VerboseLogging( )

# newVal is a boolean (input)
put_VerboseLogging( newVal )

If set to True, includes extra verbose logging in LastErrorText, LastErrorXml, and LastErrorHtml. The default value is False.

# pVal is a CkString object (output)
get_Version( pVal )

The version of the component, such as "v9.0.1"

Methods

# exeFilename is a string (input)
# resourceName is a string (input)
# zipFilename is a string (input)
# Returns a boolean value
AddEmbedded( exeFilename, resourceName, zipFilename )

Embeds a Zip file into an EXE as a custom resource. This resource can be opened by the EXE containing it at runtime by using the OpenMyEmbedded method.
Returns True for success, False for failure.

# fileExtension is a string (input)
AddNoCompressExtension( fileExtension )

Attempting to compress already-compressed data is usually a waste of CPU cycles with little or no benefit. In fact, it is possible that attempting to compress already-compressed data results in a slightly increased size. The Zip file format allows for files to be "stored" rather than compressed. This allows the file data to be streamed directly into a .zip without compression.
An instance of the Zip object has an internal list of "no compress" extensions. A filename with a "no compress" extension is "stored" rather than compressed. Additional "no compress" extensions may be added by calling this method (once per file extension). You should pass the file extension, such as ".xyz" in fileExtension.
"no compress" extensions may be removed by calling RemoveNoCompressExtension.
The default "no compress" extensions are: .zip, .gif, .jpg, .gz, .rar, .jar, .tgz, .bz2, .z, .rpm, .msi, .png

# fileName is a string (input)
# data is a string (input)
# Returns a CkZipEntry object
AppendBase64( fileName, data )

Creates a new Zip entry and initializes it with already-compressed data that is Base64 encoded. (The ZipEntry.CopyBase64 method can be used to retrieve the compressed data in Base64 format.)
Returns a null reference on failure

# filename is a string (input)
# inData is a CkByteData object (input)
# Returns a CkZipEntry object
AppendCompressed( filename, inData )

Append memory data that is already Zip-compressed to the Zip object. The ZipEntry object containing the compressed data is returned. Note: This method appends the compressed data for a single zip entry. To load an entire in-memory .zip, call OpenFromMemory instead.
Returns a null reference on failure

# fileName is a string (input)
# data is a CkByteData object (input)
# Returns a CkZipEntry object
AppendData( fileName, data )

Appends in-memory data as a new entry to a Zip object. The ZipEntry object containing the data is returned.
Returns a null reference on failure

# fileName is a string (input)
# data is a string (input)
# dataLen is an integer (input)
# Returns a CkZipEntry object
AppendData( fileName, data, dataLen )

Appends in-memory data as a new entry to a Zip object. The ZipEntry object containing the data is returned.
Returns a null reference on failure

# filePattern is a string (input)
# recurse is a boolean (input)
# Returns a boolean value
AppendFiles( filePattern, recurse )

Appends one or more files to the Zip object. The filePattern can use the "*" wildcard character for 0 or more of any characterSet recurse equal to True to recursively add all subdirectories, or False to only add files in the current directory.
Returns True for success, False for failure.

# filePattern is a string (input)
# recurse is a boolean (input)
# saveExtraPath is a boolean (input)
# archiveOnly is a boolean (input)
# includeHidden is a boolean (input)
# includeSystem is a boolean (input)
# Returns a boolean value
AppendFilesEx( filePattern, recurse, saveExtraPath, archiveOnly, includeHidden, includeSystem )

Appends one or more files to the Zip object. The filePattern can use the "*" wildcard characters. "*" means 0 or more of any character, and "?" means any single character. Set recurse equal to True to recursively add all subdirectories, or False to only add files in the current directory. Other parameters are to control whether or not the full pathname is included with the Zip entry, or whether files with the Archive, Hidden, or System attributes are included. True = yes, False = no.
Returns True for success, False for failure.

# fileName is a string (input)
# data is a string (input)
# Returns a CkZipEntry object
AppendHex( fileName, data )

Creates a new Zip entry and initializes it with already-compressed data that is hexidecimal encoded. (The ZipEntry.CopyHex method can be used to retrieve the compressed data in Hex format.)
Returns a null reference on failure

# fileSpecs is a CkStringArray object (input)
# recurse is a boolean (input)
# Returns a boolean value
AppendMultiple( fileSpecs, recurse )

This method is the same as calling AppendFiles multiple times - once for each file pattern in fileSpecs

# fileName is a string (input)
# Returns a CkZipEntry object
AppendNew( fileName )

Appends a new and empty entry to the Zip object and returns the ZipEntry object. Data can be appended to the entry by calling ZipEntry.AppendData.
Returns a null reference on failure

# dirName is a string (input)
# Returns a CkZipEntry object
AppendNewDir( dirName )

Adds an entry to the zip so that when it unzips, a new directory (with no files) is created. The directory does not need to exist on the local filesystem when calling this method. The dirName is simply a string that is used as the directory path for the entry added to the zip. The zip entry object is returned.
Returns a null reference on failure

# fileOrDirName is a string (input)
# Returns a boolean value
AppendOneFileOrDir( fileOrDirName )

Appends a single file or directory to the Zip object.

# fileOrDirName is a string (input)
# saveExtraPath is a boolean (input)
# Returns a boolean value
AppendOneFileOrDir( fileOrDirName, saveExtraPath )

Appends a single file or directory to the Zip object.

# fileName is a string (input)
# str is a string (input)
# Returns a CkZipEntry object
AppendString( fileName, str )

Adds an in-memory string to the Zip object. The Unicode string parameter is converted to the ANSI charset before being added to the Zip. If the Zip were written to disk by calling WriteZip, and later unzipped, the entry would unzip to an ANSI text file.
Returns a null reference on failure

# fileName is a string (input)
# str is a string (input)
# charset is a string (input)
# Returns a CkZipEntry object
AppendString2( fileName, str, charset )

To be documented soon.
Returns a null reference on failure

# zipFileName is a string (input)
# Returns a boolean value
AppendZip( zipFileName )

Adds the contents of another existing Zip file to this Zip object.
Returns True for success, False for failure.

CloseZip( )

Closes an open Zip file. This is identical to calling NewZip. (NewZip closes the current Zip file, if open, and initializes the Zip object to be empty. Zip files are only created when WriteZip is called.)

# entry is a CkZipEntry object (input)
# Returns a boolean value
DeleteEntry( entry )

Removes a Zip entry from the calling Zip object.
Returns True for success, False for failure.

# dirName is a string (input)
ExcludeDir( dirName )

Adds a directory name to be excluded when AppendFiles is called to add an entire directory tree. All directories having a name equal to an excluded directory will not be included when AppendFiles (or AppendFileEx) is called. Multiple directories can be excluded by calling ExcludeDir multiple times.

# dirPath is a string (input)
# Returns a boolean value
Extract( dirPath )

Unzip all the files into the specified directory. Subdirectories are automatically created as needed.
Returns True for success, False for failure.

# dirPath is a string (input)
# Returns a boolean value
ExtractInto( dirPath )

Unzips all the files in a Zip into a single directory regardless of the path stored in the Zip
Returns True for success, False for failure.

# dirPath is a string (input)
# pattern is a string (input)
# Returns a boolean value
ExtractMatching( dirPath, pattern )

Unzip all files matching a wildcard pattern.
Returns True for success, False for failure.

# dirPath is a string (input)
# Returns a boolean value
ExtractNewer( dirPath )

Extracts only the files that have more recent last-modified-times than the files on disk. This allows you to easily refresh only the files that have been updated.
Returns True for success, False for failure.

# Returns a CkZipEntry object
FirstEntry( )

Return the first entry in the Zip. Call ZipEntry.NextEntry to iterate over the entries in a Zip until a NULL is returned.
Returns a null reference on failure

# pattern is a string (input)
# Returns a CkZipEntry object
FirstMatchingEntry( pattern )

Returns the first entry having a filename matching a pattern. The "*" characters matches 0 or more of any character. The full filename, including path, is used when matching against the pattern. A NULL is returned if nothing matches.
Returns a null reference on failure

# xml is a CkString object (output)
GetDirectoryAsXML( xml )

Return the contents of the Zip file directory in an XML formatted string
Returns True for success, False for failure.

# entryID is an integer (input)
# Returns a CkZipEntry object
GetEntryByID( entryID )

Retrieves a ZipEntry by ID. Chilkat Zip.NET automatically assigns a unique ID to each ZipEntry in the Zip. This feature makes it easy to associate an item in a UI control with a ZipEntry.
Returns a null reference on failure

# index is an integer (input)
# Returns a CkZipEntry object
GetEntryByIndex( index )

Retrieves a ZipEntry by index. The first entry is at index 0. This will return directory entries as well as files.
Returns a null reference on failure

# entryName is a string (input)
# Returns a CkZipEntry object
GetEntryByName( entryName )

Returns a ZipEntry by filename. If a full or partial path is part of the filename, this must be included in the filename parameter.
Returns a null reference on failure

GetExclusions( )

Returns the current collection of exclusion patterns that have been set by SetExclusions.
Returns a null reference on failure

# name is a string (input)
# value is a CkString object (output)
GetExeConfigParam( name, value )

To be documented soon...

# fileName is a string (input)
# beforeIndex is an integer (input)
# Returns a CkZipEntry object
InsertNew( fileName, beforeIndex )

Inserts a new and empty entry into the Zip object. To insert at the beginning of the Zip, beforeIndex should be 0. The ZipEntry's FileName property is initialized to fileName parameter.
Returns a null reference on failure

# fileExtension is a string (input)
# Returns a boolean value
IsNoCompressExtension( fileExtension )

To be documented soon...

# zipFilename is a string (input)
# Returns a boolean value
IsPasswordProtected( zipFilename )

Return True if a Zip file is password protected

# Returns a boolean value
IsUnlocked( )

Returns True if the class is already unlocked, otherwise returns False.

# ZipFileName is a string (input)
# Returns a boolean value
NewZip( ZipFileName )

Clears and initializes the contents of the Zip object. If a Zip file was open, it is closed and all entries are removed from the object. The FileName property is set to the filename parameter.

# exeFilename is a string (input)
# resourceName is a string (input)
# Returns a boolean value
OpenEmbedded( exeFilename, resourceName )

Opens a Zip embedded in an EXE
Returns True for success, False for failure.

# zipFileInMemory is a string (input)
# dataLen is an integer (input)
# Returns a boolean value
OpenFromMemory( zipFileInMemory, dataLen )

Open a Zip that is completely in-memory. This allows for Zip files to be opened from non-filesystem sources, such as a database.
Returns True for success, False for failure.

# url is a string (input)
# Returns a boolean value
OpenFromWeb( url )

Opens a Zip directly from a URL. The entire contents of the Zip are downloaded and loaded into memory before returning.
Returns True for success, False for failure.

# ZipFileName is a string (input)
# Returns a boolean value
OpenZip( ZipFileName )

Opens a Zip archive. Encrypted and password-protected zips may be opened without providing the password, but their contents may not be unzipped unless the correct password is provided via the DecryptPassword proprety, or the SetPassword method.
When a zip is opened, the PasswordProtect and Encryption properties will be appropriately set. If the zip is password protected (i.e. uses older Zip 2.0 encrypion), then the PasswordProtect property will be set to True. If the zip is strong encrypted, the Encryption property will be set to a value 1 through 4, where 4 indicates WinZip compatible AES encryption.
Returns True for success, False for failure.

# zipFilename is a string (input)
# Returns a boolean value
QuickAppend( zipFilename )

Efficiently appends additional files to an existing zip archive. QuickAppend leaves all entries in the existing .zip untouched. It operates by appending new files and updating the internal "central directory" of the zip archive.
Returns True for success, False for failure.
Append Files to Existing Zip w/out Rewriting Entire Zip

# exeFilename is a string (input)
# resourceName is a string (input)
# Returns a boolean value
RemoveEmbedded( exeFilename, resourceName )

Removes an embedded Zip from an EXE
Returns True for success, False for failure.

# fileExtension is a string (input)
RemoveNoCompressExtension( fileExtension )

Removes a file extension from the zip object's internal list of "no compress" extensions. (For more information, see AddNoCompressExtension.)

# exeFilename is a string (input)
# resourceName is a string (input)
# zipFilename is a string (input)
# Returns a boolean value
ReplaceEmbedded( exeFilename, resourceName, zipFilename )

Replace a Zip embedded in an EXE with another Zip file.
Returns True for success, False for failure.

# filename is a string (input)
# Returns a boolean value
SaveLastError( filename )

Saves the last error information to an XML formatted file.

# level is an integer (input)
SetCompressionLevel( level )

Sets the compression level for all Zip entries. The default compression level is 6. A compression level of 0 is equivalent to no compression. The maximum compression level is 9.
The zip.SetCompressionLevel method must be called after appending the files (i.e. after the calls to AppendFile*, AppendData, or AppendOneFileOrDir).
A single call to SetCompressionLevel will set the compression level for all existing entries.

# excludePatterns is a CkStringArray object (input)
SetExclusions( excludePatterns )

Specify a collection of exclusion patterns to be used when adding files to a Zip. Each pattern in the collection can use the "*" wildcard character, where "*" indicates 0 or more occurances of any character.

# paramName is a string (input)
# paramValue is a string (input)
SetExeConfigParam( paramName, paramValue )

Sets a self-extractor property that is embedded in the resultant EXE created by the WriteExe or WriteExe2 methods. The paramName is one of the XML tags listed in the ExeXmlConfig property.
For example, to specify the text for the self-extractor's main dialog unzip button, paramName would be "MainUnzipBtn".

# password is a string (input)
SetPassword( password )

Set the password for an encrypted or password-protected Zip.

# regCode is a string (input)
# Returns a boolean value
UnlockComponent( regCode )

Unlocks the component allowing for the full functionality to be used. Returns true if the unlock code is valid.

# dirPath is a string (input)
# Returns an integer value
Unzip( dirPath )

Unzips and returns the number of files unzipped, or -1 if a failure occurs. Subdirectories are automatically created during the unzipping process.

# dirPath is a string (input)
# Returns an integer value
UnzipInto( dirPath )

Unzips and returns the number of files unzipped, or -1 if a failure occurs. All files in the Zip are unzipped into the specfied dirPath regardless of the directory path information contained in the Zip. This has the effect of collapsing all files into a single directory. If several files in the Zip have the same name, the files unzipped last will overwrite the files already unzipped.

# dirPath is a string (input)
# pattern is a string (input)
# verbose is a boolean (input)
# Returns an integer value
UnzipMatching( dirPath, pattern, verbose )

Same as Unzip, but only unzips files matching a pattern. If no wildcard characters ('*') are used, then only files that exactly match the pattern will be unzipped. The "*" characters matches 0 or more of any character.

# dirPath is a string (input)
# pattern is a string (input)
# verbose is a boolean (input)
# Returns an integer value
UnzipMatchingInto( dirPath, pattern, verbose )

Unzips matching files into a single directory, ignoring all path information stored in the Zip.

# dirPath is a string (input)
# Returns an integer value
UnzipNewer( dirPath )

Same as Unzip, but only files that don't already exist on disk, or have later file modification dates are unzipped.

# Returns a boolean value
VerifyPassword( )

Tests the current DecryptPassword setting against the currently opened zip. Returns True if the password is valid, otherwise returns False.
Verify a Zip's Password

# filename is a string (input)
# Returns a boolean value
WriteExe( filename )

Writes a self-extracting executable. There are no limitations on the total size, individual file size, or number of files that can be added to a self-extracting EXE.
If the resultant EXE will automatically accept these command-line arguments when run:

-log logFileName

Creates a log file that lists the settings embedded within the EXE and logs the errors, warnings, and other information about the self-extraction.

-unzipDir unzipDirectoryPath

Unzips to this directory path without user intervention.

-pwd password

Specifies the password for an encrypted EXE

-ap autoRunParams

Specifies the command line parameters to be passed to the AutoRun executable (embedded within the EXE).

Returns True for success, False for failure.
Create Self-Extractor

# exeFilename is a string (input)
# outExeFilename is a string (input)
# bAesEncrypt is a boolean (input)
# keyLength is an integer (input)
# password is a string (input)
# Returns a boolean value
WriteExe2( exeFilename, outExeFilename, bAesEncrypt, keyLength, password )

Writes a self-extracting EXE with no limitations on total file size and no limitations on the size of any one file contained within. The 1st argument is the pre-existing EXE housing that is to be used. Essentially, the self-extracting EXE is a concatenation of the EXE housing and the compressed/encrypted data. The 2nd argument is the name of the EXE to create or overwrite. A housing for use with WriteExe2 can be found here: http://www.chilkatsoft.com/d2/SaExtract.zip
Returns True for success, False for failure.

# outBytes is a CkByteData object (output)
# Returns a boolean value
WriteExeToMemory( outBytes )

To be documented soon...

# bData is a CkByteData object (output)
# Returns a boolean value
WriteToMemory( bData )

Same as WriteZip, but instead of writing the Zip to a file, it writes to memory. Zips that are written to memory can also be opened from memory by calling OpenFromMemory.

# Returns a boolean value
WriteZip( )

Saves the Zip to a file and implictly re-opens it so further operations can continue. Use WriteZipAndClose to write and close the Zip. There is no limitation on the size of files that may be contained within a .zip, the total number of files in a .zip, or the total size of a .zip. If necessary, WriteZip will use the ZIP64 file format extensions when 4GB or file count limitations of the old zip file format are exceeded.
Returns True for success, False for failure.

# Returns a boolean value
WriteZipAndClose( )

Saves the Zip to a file and closes it. On return, the Zip object will be in the state as if NewZip had been called. There is no limitation on the size of files that may be contained within a .zip, the total number of files in a .zip, or the total size of a .zip. If necessary, WriteZip will use the ZIP64 file format extensions when 4GB or file count limitations of the old zip file format are exceeded.
Returns True for success, False for failure.

# Returns a string
appendFromDir( )

When files are added to a Zip archive, they are appended from this directory. For example, if you wish to add all the files under c:/abc/123/myAppDir, you might set this property equal to "c:/abc/123", and then pass "myAppDir/*" to AppendFiles.
Controlling Paths of Files Added to Zip

# Returns a string
autoRun( )

Optional when creating self-extracting EXEs. This is the name of an executable contained within the to-be-created EXE that will automatically be run after extraction. (This is typically something like "setup.exe")

# Returns a string
autoRunParams( )

Command line parameters that get passed to the AutoRun executable.

# Returns a string
decryptPassword( )

When opening a password-protected or AES encrypted Zip, this is the password to be used for decryption. Encrypted Zips may be opened without setting a password, but the contents cannot be unzipped without setting this password.
Note:The SetPassword method has the effect of setting both this property as well as the EncryptPassword property. The SetPassword method should no longer be used. It has been replaced by the DecryptPassword and EncryptPassword properties to make it possible to open an encrypted zip and re-write it with a new password.

# Returns a string
encryptPassword( )

The password used when writing a password-protected or strong-encrytped Zip.
Note:The SetPassword method has the effect of setting both this property as well as the DecryptPassword property. The SetPassword method should no longer be used. It has been replaced by the DecryptPassword and EncryptPassword properties to make it possible to open an encrypted zip and re-write it with a new password.

# Returns a string
exeDefaultDir( )

Specifies the default unzip directory path to appear in the user-interface dialog box when the self-extracting EXE is run.

# Returns a string
exeIconFile( )

Applies to creating self-extracting EXEs. This property can be set to a pre-existing icon filename (.ico) that will be embedded within the to-be-created EXE and set as its default icon.

# Returns a string
exeSourceUrl( )

This property allows you to create a self-extracting EXE where the data to be extracted is not actually contained within the EXE. Instead, when the self-extracting EXE is run, your zip is downloaded from a URL and unzipped. The self-extracting EXE will automatically use the proxy specified by Internet Explorer if one is defined.
In practice, you would prepare your .zip and place it on your web server at a publicly accessible URL. You may then create and distribute self-extracting EXEs that have this URL embedded. Your zip on the web server may be updated at will, and your already-distributed self-extracting EXEs will always download and unzip the latest files.

# Returns a string
exeTitle( )

Applies to creating self-extracting EXEs. Sets the title of the main user-interface dialog that appears when the self-extracting EXE runs.

# Returns a string
exeUnzipCaption( )

Applies to creating self-extracting EXEs. Sets the unzipping caption of the main user-interface dialog that appears when the self-extracting EXE runs.

# Returns a string
exeUnzipDir( )

Applies to creating self-extracting EXEs. Stores a pre-defined unzip directory within the self-extracting EXE so that it automatically unzips to this directory without user-intervention.
Environment variables may be included if surrounded by percent characters. For example: %TEMP%. Environment variables are expanded (i.e. resolved) when the self-extracting EXE runs.
Note: To create a self-extracting EXE with no user-interaction, set the following properties to these values:
ExeSilentProgress = False
ExeNoInterface = True
ExeFinishNotifier = False

# Returns a string
exeXmlConfig( )

Allows for an XML config document to be used to specify all possible options for self-extracting EXEs. This property is a string containing the XML config document.

The XML should have this format:

<SfxConfig>
	<ErrPwdTitle>Title for incorrect password dialog</ErrPwdTitle>
	<ErrPwdCaption>Caption for incorrect password dialog</ErrPwdCaption>
	<FinOkBtn>Text on finish notifier button</FinOkBtn>
	<PwdOkBtn>Text on password challenge dialog's "OK" button.</PwdOkBtn>
	<PwdCancelBtn>Text on password challenge dialog's Cancel button.</PwdCancelBtn>
	<ErrInvalidPassword>Incorrect password error message.</ErrInvalidPassword>
	<MainUnzipBtn>Text on main dialog's unzip button</MainUnzipBtn>
	<MainCloseBtn>Text on main dialog's quit/exit button</MainCloseBtn>
	<MainBrowseBtn>Text on main dialog's browse-for-directory button.</MainBrowseBtn>
	<MainUnzipLabel>Caption displayed in main dialog.</MainUnzipLabel>
	<AutoTemp>"1|0"</AutoTemp>
	<ShowFin>"1|0" Maps to ExeFinishNotifier property.</ShowFin>
	<ShowMain>"1|0" Maps to ExeNoInterface property.</ShowMain>
	<ShowProgress>"1|0" Maps to ExeSilentProgress property.</ShowProgress>
	<WaitForSetup>"1|0" Maps to ExeWaitForSetup property.</WaitForSetup>
	<Encryption>"1|0"  1=Yes, 0=No</Encryption>
	<KeyLength>128|192|256</KeyLength>
	<SetupExe>EXE to run after extracting. (Maps to AutoRun property)</SetupExe>
	<UnzipDir>Pre-defined unzip directory. (Maps to ExeUnzipDir property)>
	<DefaultDir>Default unzip directory to appear in the main dialog. 
                                                (Maps to ExeDefaultDir property)</DefaultDir>
	<IconFile>Icon file to be used (Maps to ExeIconFile property)</IconFile>
	<Url>Maps to ExeSourceUrl property.</Url>
	<MainTitle>Maps to ExeTitle property.</MainTitle>
	<MainCaption>Maps to ExeUnzipCaption property.</MainCaption>
	<FinTitle>Title for the finish notifier dialog.</FinTitle>
	<FinCaption>Caption for the finish notifier dialog.</FinTitle>
	<ProgressTitle>Title for the progress dialog.</ProgressTitle>
	<ProgressCaption>Caption for the progress dialog.</ProgressCaption>
	<PwTitle>Title for the password challenge dialog.</PwTitle>
	<PwCaption>Caption for the password challenge dialog.</PwCaption>
</SfxConfig>

# Returns a string
fileName( )

The name of the Zip file. This file is created or overwritten when the Zip is saved.

# Returns a string
getDirectoryAsXML( )

Return the contents of the Zip file directory in an XML formatted string

# name is a string (input)
# Returns a string
getExeConfigParam( name )

To be documented soon...

# Returns a string
lastErrorHtml( )

Error information in HTML format for the last method called.

# Returns a string
lastErrorText( )

Error information in plain-text format for the last method called.

# Returns a string
lastErrorXml( )

Error information in XML format for the last method called.

# Returns a string
pathPrefix( )

A prefix that is added to each filename when zipping. One might set the PathPrefix to "subdir/" so that files are unzipped to a specified subdirectory when unzipping.

# Returns a string
proxy( )

(Optional) The name of a proxy to be used with the OpenFromWeb method. Only necessary if your computer uses a proxy to access the Internet. The proxy string should be formatted as "hostname:port", such as "www.chilkatsoft.com:100".

# Returns a string
tempDir( )

The temporary directory to use when unzipping files. When running in ASP or ASP.NET, the default value of TempDir is set to the directory where the .zip is being written. Set this property to override the default.

# Returns a string
version( )

The version of the component, such as "v9.0.1"

CkZip Python ProgrammingReference Documentation

CkZip

CkZip Python Programming
Reference Documentation