ZipArchive.ExtractAsync Method

Namespace: Rebex.IO.Compression

Assembly: Rebex.Zip.dll

ExtractAsync(String, String, TraversalMode, TransferMethod, ActionOnExistingFiles, Object)

Begins asynchronous Extract operation. Extracts specified archive item(s) into the specified local directory.

Declaration

public Task<ArchiveOperationResult> ExtractAsync(string archivePathOrMask, string targetDirectoryPath, TraversalMode mode, TransferMethod transferMethod, ActionOnExistingFiles defaultActionOnExistingFiles, object state = null)

Parameters

Type	Name	Description
String	archivePathOrMask	Path (with or without a mask) to an archive item(s).
String	targetDirectoryPath	Path to an existing local directory to which to extract files.
TraversalMode	mode	Traversal mode.
TransferMethod	transferMethod	Specifies whether to copy or move source items.
ActionOnExistingFiles	defaultActionOnExistingFiles	Specifies the default behavior for files that already exists in the local directory.
Object	state	An optional user-provided object that identifies this particular asynchronous operation.

Returns

Type	Description
Task<ArchiveOperationResult>	Operation result.

Exceptions

Type	Condition
ArgumentNullException	The specified path is null.
ArgumentException	The specified path is empty or contains invalid characters. -or- Illegal use of wildcards in path. -or- Ambiguous usage of path and mode. -or- The system could not retrieve the absolute path.
ArgumentOutOfRangeException	The mode or transferMethod or defaultActionOnExistingFiles specified an invalid value.
ObjectDisposedException	Archive was already disposed.
NotSupportedException	Path is in an invalid format.
PathTooLongException	targetDirectoryPath exceed the maximum length defined by system.
SecurityException	The caller does not have the required permissions.
UnauthorizedAccessException	Access to the file is denied.
IOException	An I/O error occurred.
ZipException	Cannot perform the requested operation, or the operation was canceled (see ProblemType for detailed information).

ExtractAsync(FileSet, String, TransferMethod, ActionOnExistingFiles, Object)

Begins asynchronous Extract operation. Extracts specified archive item(s) into the specified local directory.

Declaration

public Task<ArchiveOperationResult> ExtractAsync(FileSet set, string targetDirectoryPath, TransferMethod transferMethod, ActionOnExistingFiles defaultActionOnExistingFiles, object state = null)

Parameters

Type	Name	Description
FileSet	set	A filtering set which specifies external (local) files and directories to be extracted.
String	targetDirectoryPath	Path to an existing local directory to which to extract files.
TransferMethod	transferMethod	Specifies whether to copy or move source items.
ActionOnExistingFiles	defaultActionOnExistingFiles	Specifies the default behavior for files that already exists in the local directory.
Object	state	An optional user-provided object that identifies this particular asynchronous operation.

Returns

Type	Description
Task<ArchiveOperationResult>	Operation result.

Exceptions

Type	Condition
ArgumentNullException	set is null or the specified path is null.
ArgumentException	The specified path is empty or contains invalid characters. -or- The system could not retrieve the absolute path.
ArgumentOutOfRangeException	The transferMethod or defaultActionOnExistingFiles specified an invalid value.
ObjectDisposedException	Archive was already disposed.
NotSupportedException	Path is in an invalid format.
PathTooLongException	targetDirectoryPath exceed the maximum length defined by system.
SecurityException	The caller does not have the required permissions.
UnauthorizedAccessException	Access to the file is denied.
IOException	An I/O error occurred.
ZipException	Cannot perform the requested operation, or the operation was canceled (see ProblemType for detailed information).