Adds specified local files or directories to a directory within the ZIP archive.
Namespace:
Rebex.IO.Compression
Assembly:
Rebex.Zip (in Rebex.Zip.dll)
Syntax
Visual Basic |
---|
Public Function Add ( _ sourcePathOrMask As String, _ archiveDirectoryPath As String, _ mode As TraversalMode, _ transferMethod As TransferMethod, _ defaultActionOnExistingFiles As ActionOnExistingFiles _ ) As ArchiveOperationResult |
C# |
---|
public ArchiveOperationResult Add( string sourcePathOrMask, string archiveDirectoryPath, TraversalMode mode, TransferMethod transferMethod, ActionOnExistingFiles defaultActionOnExistingFiles ) |
Parameters
- sourcePathOrMask
- Type: System..::..String
Path (with or without a mask) to an external (local) file or directory.
- archiveDirectoryPath
- Type: System..::..String
Path to an archive directory where to add files. Null reference (Nothing in Visual Basic) means root.
- mode
- Type: Rebex.IO..::..TraversalMode
Traversal mode.
- transferMethod
- Type: Rebex.IO..::..TransferMethod
Specifies whether to copy or move source items.
- defaultActionOnExistingFiles
- Type: Rebex.IO..::..ActionOnExistingFiles
Specifies the default behavior for files that already exist in the ZIP archive.
Return Value
Operation result.Exceptions
Exception | Condition |
---|---|
System..::..ArgumentNullException | sourcePathOrMask is null. |
System..::..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. |
System..::..ArgumentOutOfRangeException | The mode or transferMethod or defaultActionOnExistingFiles specified an invalid value. |
System..::..InvalidOperationException | Archive is not opened for writing. -or- sourcePathOrMask refers to the ZIP archive itself. |
System..::..ObjectDisposedException | Archive was already disposed. |
System..::..NotSupportedException | Path is in an invalid format. |
System.IO..::..PathTooLongException | sourcePathOrMask exceeds the maximum length defined by system. -or- The target path is longer than 65.535 characters. |
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). |