Chilkat .NET
Components for Email, Zip Compression, Encryption, XML, S/MIME, and Character
Encoding Conversion
Chilkat .NET
Components for Email, Zip Compression, Encryption, XML, S/MIME, and Character
Encoding Conversion
 |
Properties | Description | ||
| AppendFromDir | When files are added to a Zip archive, they are appended from this directory.
|
|||
| Comment | The global Zip file comment.
|
|||
| Encryption | The symmetric encryption algorithm. Valid values are: 0 = none, 1 = blowfish, 2 = twofish, 3 = rijndael (AES). When a Zip is encrypted, the directory will still be readable by programs such as WinZip, but the contents, if unzipped, will be garbled. Only applications using Zip.NET can decrypt and unzip Zip files created by Zip.NET.
|
|||
| EncryptKeyLength | The encryption key length if symmetric encryption is used. This value must be 128, 192, or 256.
|
|||
| FileName | The name of the Zip file. This file is created or overwritten when the Zip is saved.
|
|||
| LastError | An XML-formatted string containing error information, if any, of the last method call.
|
|||
| NumEntries | The number of entries in the Zip, including both files and directories.
|
|||
| PasswordProtect | True if the Zip should be password-protected using standard Zip password-protection.
|
|||
| 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.
|
|||
| TempDir | The temporary directory to use when unzipping files.
|
|||
| Version | The version of the component, such as "v9.0.1"
|
|
Methods | Description | ||
| AddEmbedded | 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.
|
|||
| AppendBase64 | 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.)
|
|||
| AppendCompressed | Append memory data that is already Zip-compressed to the Zip object. The ZipEntry object containing the compressed data is returned.
|
|||
| AppendData | Appends in-memory data as a new entry to a Zip object. The ZipEntry object containing the data is returned.
|
|||
| AppendFilesEx | Appends one or more files to the Zip object. The filePattern can use
the "*" or "?" 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.
|
|||
| AppendFiles | Appends one or more files to the Zip object. The filePattern can use
the "*" or "?" 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.
|
|||
| AppendHex | 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.)
|
|||
| AppendMultiple | This method is the same as calling AppendFiles multiple times - once for each file pattern in fileSpecs
|
|||
| AppendNew | 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.
|
|||
| AppendZip | Adds the contents of another existing Zip file to this Zip object.
|
|||
| 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.)
|
|||
| DeleteEntry | Removes a Zip entry from the calling Zip object.
|
|||
| ExtractInto | Unzips all the files in a Zip into a single directory regardless of the path stored in the Zip
|
|||
| ExtractMatching | Unzip all files matching a wildcard pattern.
|
|||
| ExtractNewer | 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.
|
|||
| Extract | Unzip all the files into the specified directory. Subdirectories are automatically created as needed.
|
|||
| FirstEntry | Return the first entry in the Zip. Call ZipEntry.NextEntry to iterate over the entries in a Zip until a NULL is returned.
|
|||
| FirstMatchingEntry | Returns the first entry having a filename matching a pattern. The "*" and "?" characters have their usual wildcard meanings. The full filename, including path, is used when matching against the pattern. A NULL is returned if nothing matches.
|
|||
| GetDirectoryAsXML | Return the contents of the Zip file directory in an XML formatted string
|
|||
| GetEntryByID | 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.
|
|||
| GetEntryByIndex | Retrieves a ZipEntry by index. The first entry is at index 0. This will return directory entries as well as files.
|
|||
| GetEntryByName | Returns a ZipEntry by filename. If a full or partial path is part of the filename, this must be included in the filename parameter.
|
|||
| GetExclusions | Returns the current collection of exclusion patterns that have been set by SetExclusions.
|
|||
| InsertNew | 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.
|
|||
| IsPasswordProtected | Return True if a Zip file is password protected
|
|||
| IsUnlocked | Returns True if the class is already unlocked, otherwise returns False.
|
|||
| NewZip | 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.
|
|||
| OpenEmbedded | Opens a Zip embedded in an EXE
|
|||
| OpenFromMemory | Open a Zip that is completely in-memory. This allows for Zip files to be opened from non-filesystem sources, such as a database.
|
|||
| OpenMyEmbedded | Opens a Zip embedded within the caller's EXE.
|
|||
| OpenZip | Open a Zip file
|
|||
| OpenFromWeb | Opens a Zip directly from a URL. The entire contents of the Zip are downloaded and loaded into memory before returning.
|
|||
| RemoveEmbedded | Removes an embedded Zip from an EXE
|
|||
| ReplaceEmbedded | Replace a Zip embedded in an EXE with another Zip file.
|
|||
| SaveLastError | Saves the error log to an XML log file
|
|||
| SetExclusions | Specify a collection of exclusion patterns to be used when adding files to a Zip. Each pattern
in the collection can use the "*" and "?" wildcard characters, where "*" indicates 0 or more occurances of any character, and "?" represents exactly one occurance of any character.
|
|||
| SetPassword | Set the password for an encrypted or password-protected Zip.
|
|||
| UnlockComponent | Unlocks the component allowing for the full functionality to be used.
Returns true if the unlock code is valid.
|
|||
| WriteExe | Saves the Zip to a self-extracting executable.
|
|||
| 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.
|
|||
| 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.
|
Copyright 2002, Chilkat Software, Inc. All Rights Reserved.