Extracts the current file item into a local file.
Namespace:
Rebex.IO.Compression
Assembly:
Rebex.Zip (in Rebex.Zip.dll)
Syntax
Visual Basic |
---|
Public Function ExtractToFile ( _ targetFilePath As String, _ defaultActionOnExistingFiles As ActionOnExistingFiles _ ) As ArchiveOperationResult |
C# |
---|
public ArchiveOperationResult ExtractToFile( string targetFilePath, ActionOnExistingFiles defaultActionOnExistingFiles ) |
Parameters
- targetFilePath
- Type: System..::..String
Path to a (non-existing) local file where to extract the file item.
- defaultActionOnExistingFiles
- Type: Rebex.IO..::..ActionOnExistingFiles
Specifies the default behavior for files that already exists in the local directory.
Return Value
Operation result.Exceptions
Exception | Condition |
---|---|
System..::..ArgumentNullException | The specified path is null. |
System..::..ArgumentException | The specified path is empty or contains invalid characters. -or- The system could not retrieve the absolute path. |
System..::..InvalidOperationException | The item is not a file. -or- The item is already deleted. |
System..::..ObjectDisposedException | Archive was already disposed. |
System..::..NotSupportedException | Path is in an invalid format. |
System.IO..::..PathTooLongException | targetFilePath exceed the maximum length defined by system. |
System.IO..::..DirectoryNotFoundException | Part of the target path was not found. |
System.Security..::..SecurityException | The caller does not have the required permissions. |
System..::..UnauthorizedAccessException | Access to the file is denied. |
System.IO..::..IOException | An I/O error occurred. |
Rebex.IO.Compression..::..ZipException | Cannot perform the requested operation, or the operation was canceled (see ProblemType for detailed information). |