ZipArchive.GetItems Method
Namespace: Rebex.IO.Compression
Assembly: Rebex.Zip.dll (version 7.0.9313)
GetItems()
Gets the collection of all archive items stored within the ZIP archive.
Declaration
public ZipItemCollection GetItems()Returns
| Type | Description |
|---|---|
| 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). |
GetItems(String, TraversalMode)
Gets the collection of archive items stored within the ZIP archive matching the specified path or mask using the specified traversal mode.
Declaration
public ZipItemCollection GetItems(string archivePathOrMask, TraversalMode mode)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. |
Returns
| Type | Description |
|---|---|
| ZipItemCollection | The collection of 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 |
| ObjectDisposedException | Archive was already disposed. |
| ZipException | Cannot perform the requested operation, or the operation was canceled (see ProblemType for detailed information). |
GetItems(String, TraversalMode, ArchiveItemTypes)
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 ZipItemCollection GetItems(string archivePathOrMask, TraversalMode mode, ArchiveItemTypes types)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. |
Returns
| Type | Description |
|---|---|
| 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 |
| ObjectDisposedException | Archive was already disposed. |
| ZipException | Cannot perform the requested operation, or the operation was canceled (see ProblemType for detailed information). |
GetItems(FileSet)
Gets the collection of archive items stored within the ZIP archive matching the specified set.
Declaration
public ZipItemCollection GetItems(FileSet set)Parameters
| Type | Name | Description |
|---|---|---|
| FileSet | set | A FileSet defining the filter criteria. |
Returns
| Type | Description |
|---|---|
| ZipItemCollection | The collection of archive items stored within the ZIP archive. |
Exceptions
| Type | Condition |
|---|---|
| ArgumentNullException | The specified set is null. |
| ObjectDisposedException | Archive was already disposed. |
| ZipException | Cannot perform the requested operation, or the operation was canceled (see ProblemType for detailed information). |
GetItems(FileSet, ArchiveItemTypes)
Gets the collection of archive items stored within the ZIP archive matching the specified set.
Declaration
public ZipItemCollection GetItems(FileSet set, ArchiveItemTypes types)Parameters
| Type | Name | Description |
|---|---|---|
| FileSet | set | A FileSet defining the filter criteria. |
| ArchiveItemTypes | types | Specifies which types should be included in the collection. |
Returns
| Type | Description |
|---|---|
| ZipItemCollection | The collection of archive items stored within the ZIP archive. |
Exceptions
| Type | Condition |
|---|---|
| ArgumentNullException | The specified set is null. |
| ArgumentOutOfRangeException | The |
| ObjectDisposedException | Archive was already disposed. |
| ZipException | Cannot perform the requested operation, or the operation was canceled (see ProblemType for detailed information). |