ZipArchive.GetItemsAsync Method

Namespace: Rebex.IO.Compression

Assembly: Rebex.Zip.dll (version 7.0.9147)

GetItemsAsync(Object)

Begins asynchronous GetItems operation. Gets the collection of all archive items stored within the ZIP archive.

Declaration

public Task<ZipItemCollection> GetItemsAsync(object state = null)

Parameters

Type	Name	Description
Object	state	An optional user-provided object that identifies this particular asynchronous operation.

Returns

Type	Description
Task<ZipItemCollection>	The collection of all items stored within the ZIP archive.

Exceptions

Type	Condition
ObjectDisposedException	Archive was already disposed.
ZipException	Cannot perform the requested operation, or the operation was canceled (see ProblemType for detailed information).

GetItemsAsync(String, TraversalMode, ArchiveItemTypes, Object)

Begins asynchronous GetItems operation. Gets the collection of archive items stored within the ZIP archive matching the specified path or mask and type using the specified traversal mode.

Declaration

public Task<ZipItemCollection> GetItemsAsync(string archivePathOrMask, TraversalMode mode, ArchiveItemTypes types, object state = null)

Parameters

Type	Name	Description
String	archivePathOrMask	Path (with or without a mask) to an archive item(s) or null (Nothing in Visual Basic).
TraversalMode	mode	Traversal mode.
ArchiveItemTypes	types	Specifies which types should be included in the collection.
Object	state	An optional user-provided object that identifies this particular asynchronous operation.

Returns

Type	Description
Task<ZipItemCollection>	The collection of archive items stored within the ZIP archive.

Exceptions

Type	Condition
ArgumentNullException	The specified path is null.
ArgumentException	The specified path is empty. -or- Illegal use of wildcards in path. -or- Ambiguous usage of path and mode.
ArgumentOutOfRangeException	The mode or types specified an invalid value.
ObjectDisposedException	Archive was already disposed.
ZipException	Cannot perform the requested operation, or the operation was canceled (see ProblemType for detailed information).

GetItemsAsync(FileSet, ArchiveItemTypes, Object)

Begins asynchronous GetItems operation. Gets the collection of archive items stored within the ZIP archive matching the specified set.

Declaration

public Task<ZipItemCollection> GetItemsAsync(FileSet set, ArchiveItemTypes types, object state = null)

Parameters

Type	Name	Description
FileSet	set	A FileSet defining the filter criteria.
ArchiveItemTypes	types	Specifies which types should be included in the collection.
Object	state	An optional user-provided object that identifies this particular asynchronous operation.

Returns

Type	Description
Task<ZipItemCollection>	The collection of archive items stored within the ZIP archive.

Exceptions

Type	Condition
ArgumentNullException	The specified set is null.
ArgumentOutOfRangeException	The types specified an invalid value.
ObjectDisposedException	Archive was already disposed.
ZipException	Cannot perform the requested operation, or the operation was canceled (see ProblemType for detailed information).