Extracts specified archive item(s) into the specified local directory.

Namespace:  Rebex.IO.Compression
Assembly:  Rebex.Zip (in Rebex.Zip.dll)

Syntax

Visual Basic
Public Function Extract ( _
	archivePathOrMask As String, _
	targetDirectoryPath As String _
) As ArchiveOperationResult
C#
public ArchiveOperationResult Extract(
	string archivePathOrMask,
	string targetDirectoryPath
)

Parameters

archivePathOrMask
Type: System..::..String
Path (with or without a mask) to an archive item(s).
targetDirectoryPath
Type: System..::..String
Path to an existing local directory to which to extract files.

Return Value

Operation result.

Exceptions

ExceptionCondition
System..::..ArgumentNullExceptionThe specified path is null.
System..::..ArgumentExceptionThe specified path is empty or contains invalid characters. -or- Illegal use of wildcards in path. -or- The system could not retrieve the absolute path.
System..::..ObjectDisposedExceptionArchive was already disposed.
System..::..NotSupportedExceptionPath is in an invalid format.
System.IO..::..PathTooLongExceptiontargetDirectoryPath exceed the maximum length defined by system.
System.Security..::..SecurityExceptionThe caller does not have the required permissions.
System..::..UnauthorizedAccessExceptionAccess to the file is denied.
System.IO..::..IOExceptionAn I/O error occurred.
Rebex.IO.Compression..::..ZipExceptionCannot perform the requested operation, or the operation was canceled (see ProblemType for detailed information).

Version Information

.NET Framework

Supported in: 4.8, 4.7.x, 4.6.x, 4.5.x, 4.0, 3.5 SP1

.NET Standard 2.0

Supported in: .NET Core 3.1, 3.0, 2.1; Xamarin.Android 9.1 (or higher); Xamarin.iOS 10.3 (or higher)

See Also