SelectEntries Method (selectionCriteria, directoryPathInArchive)

DotNetZip

previous page next page

Ionic Zip Library v1.9.1.6 SelectEntries Method (selectionCriteria, directoryPathInArchive)

Retrieve entries from the zipfile by specified criteria.

Declaration Syntax

Visual Basic

Visual C++

public ICollection<ZipEntry> SelectEntries(
	string selectionCriteria,
	string directoryPathInArchive
)

Public Function SelectEntries ( _
	selectionCriteria As String, _
	directoryPathInArchive As String _
) As ICollection(Of ZipEntry)

public:
ICollection<ZipEntry^>^ SelectEntries(
	String^ selectionCriteria, 
	String^ directoryPathInArchive
)

Parameters

selectionCriteria (String): the string that specifies which entries to select

directoryPathInArchive (String): the directory in the archive from which to select entries. If null, then all directories in the archive are used.

Return Value

a collection of ZipEntry objects that conform to the inclusion spec

Remarks

This method allows callers to retrieve the collection of entries from the zipfile that fit the specified criteria. The criteria are described in a string format, and can include patterns for the filename; constraints on the size of the entry; constraints on the last modified, created, or last accessed time for the file described by the entry; or the attributes of the entry.

For details on the syntax for the selectionCriteria parameter, see AddSelectedFiles(String).

This method is intended for use with a ZipFile that has been read from storage. When creating a new ZipFile, this method will work only after the ZipArchive has been Saved to the disk (the ZipFile class subsequently and implicitly reads the Zip archive from storage.) Calling SelectEntries on a ZipFile that has not yet been saved will deliver undefined results.

Examples

CopyC#

using (ZipFile zip1 = ZipFile.Read(ZipFileName))
{
    var UpdatedPhotoShopFiles = zip1.SelectEntries("*.psd", "UpdatedFiles");
    foreach (ZipEntry e in UpdatedPhotoShopFiles)
    {
        // prompt for extract here
        if (WantExtract(e.FileName))
            e.Extract();
    }
}

CopyVB.NET

Using zip1 As ZipFile = ZipFile.Read(ZipFileName)
    Dim UpdatedPhotoShopFiles As ICollection(Of ZipEntry) = zip1.SelectEntries("*.psd", "UpdatedFiles")
    Dim e As ZipEntry
    For Each e In UpdatedPhotoShopFiles
        ' prompt for extract here
        If Me.WantExtract(e.FileName) Then
            e.Extract
        End If
    Next
End Using

Exceptions

Exception	Condition
Exception	Thrown if selectionCriteria has an invalid syntax.

Assembly: Ionic.Zip (Module: Ionic.Zip) Version: 1.9.1.8 (1.9.1.8)

previous page start next page