-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update file(s) "/." from "aspose-zip/Aspose.ZIP-API-References"
- Loading branch information
Showing
171 changed files
with
787 additions
and
161 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
18 changes: 18 additions & 0 deletions
18
content/sites/aspose/zip/english/net/aspose.zip.arj/_index.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
--- | ||
title: Aspose.Zip.ARJ | ||
second_title: Aspose.ZIP for .NET API Reference | ||
description: The ARJ namespace contains classes which represent ARJ related entities | ||
type: docs | ||
weight: 30 | ||
url: /net/aspose.zip.arj/ | ||
--- | ||
The ARJ namespace contains classes which represent ARJ related entities. | ||
|
||
## Classes | ||
|
||
| Class | Description | | ||
| --- | --- | | ||
| [ArjArchive](./arjarchive/) | This class represents ARJ archive file. | | ||
| [ArjEntryPlain](./arjentryplain/) | Represents single file within ARJ archive. | | ||
|
||
|
69 changes: 69 additions & 0 deletions
69
content/sites/aspose/zip/english/net/aspose.zip.arj/arjarchive/_index.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,69 @@ | ||
--- | ||
title: Class ArjArchive | ||
second_title: Aspose.ZIP for .NET API Reference | ||
description: Aspose.Zip.ARJ.ArjArchive class. This class represents ARJ archive file | ||
type: docs | ||
weight: 10 | ||
url: /net/aspose.zip.arj/arjarchive/ | ||
--- | ||
## ArjArchive class | ||
|
||
This class represents ARJ archive file. | ||
|
||
```csharp | ||
public class ArjArchive : IArchive | ||
``` | ||
|
||
## Constructors | ||
|
||
| Name | Description | | ||
| --- | --- | | ||
| [ArjArchive](arjarchive/#constructor)(Stream) | Initializes a new instance of the `ArjArchive` class and composes entries list can be extracted from the archive. | | ||
| [ArjArchive](arjarchive/#constructor_1)(string) | Initializes a new instance of the `ArjArchive` class and composes entries list can be extracted from the archive. | | ||
|
||
## Properties | ||
|
||
| Name | Description | | ||
| --- | --- | | ||
| [Commentary](../../aspose.zip.arj/arjarchive/commentary/) { get; } | Gets the commentary. | | ||
| [Entries](../../aspose.zip.arj/arjarchive/entries/) { get; } | Gets entries of [`ArjEntryPlain`](../arjentryplain/) type constituting the ARJ archive. | | ||
| [Name](../../aspose.zip.arj/arjarchive/name/) { get; } | Gets the original name. | | ||
|
||
## Methods | ||
|
||
| Name | Description | | ||
| --- | --- | | ||
| [Dispose](../../aspose.zip.arj/arjarchive/dispose/)() | Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. | | ||
| [ExtractToDirectory](../../aspose.zip.arj/arjarchive/extracttodirectory/)(string) | Extracts all entries to the specified directory. | | ||
|
||
## Remarks | ||
|
||
Only following compression methods are supported: | ||
|
||
**Method** | ||
|
||
**Explanation** | ||
|
||
**0** | ||
|
||
Uncompressed | ||
|
||
**1** | ||
|
||
Combination of LZ77 and adaptive Huffman coding. Best ratio. | ||
|
||
**2** | ||
|
||
Combination of LZ77 and adaptive Huffman coding. | ||
|
||
**3** | ||
|
||
Combination of LZ77 and adaptive Huffman coding. Best speed. | ||
|
||
### See Also | ||
|
||
* interface [IArchive](../../aspose.zip/iarchive/) | ||
* namespace [Aspose.Zip.ARJ](../../aspose.zip.arj/) | ||
* assembly [Aspose.Zip](../../) | ||
|
||
|
89 changes: 89 additions & 0 deletions
89
...ent/sites/aspose/zip/english/net/aspose.zip.arj/arjarchive/arjarchive/_index.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,89 @@ | ||
--- | ||
title: ArjArchive.ArjArchive | ||
second_title: Aspose.ZIP for .NET API Reference | ||
description: ArjArchive constructor. Initializes a new instance of the ArjArchive class and composes entries list can be extracted from the archive | ||
type: docs | ||
weight: 10 | ||
url: /net/aspose.zip.arj/arjarchive/arjarchive/ | ||
--- | ||
## ArjArchive(Stream) {#constructor} | ||
|
||
Initializes a new instance of the [`ArjArchive`](../) class and composes entries list can be extracted from the archive. | ||
|
||
```csharp | ||
public ArjArchive(Stream extractionSource) | ||
``` | ||
|
||
| Parameter | Type | Description | | ||
| --- | --- | --- | | ||
| extractionSource | Stream | The source of the archive. | | ||
|
||
### Exceptions | ||
|
||
| exception | condition | | ||
| --- | --- | | ||
| ArgumentNullException | *extractionSource* is null. | | ||
| ArgumentException | >*extractionSource* does not support seeking. | | ||
| InvalidDataException | Wrong signature for archive. - or - The file is not an ARJ archive. | | ||
| NotSupportedException | Archive is garbled. | | ||
|
||
## Remarks | ||
|
||
This constructor does not decompress any entry. See [`Extract`](../../arjentryplain/extract/) method for decompressing. | ||
|
||
### See Also | ||
|
||
* class [ArjArchive](../) | ||
* namespace [Aspose.Zip.ARJ](../../arjarchive/) | ||
* assembly [Aspose.Zip](../../../) | ||
|
||
--- | ||
|
||
## ArjArchive(string) {#constructor_1} | ||
|
||
Initializes a new instance of the [`ArjArchive`](../) class and composes entries list can be extracted from the archive. | ||
|
||
```csharp | ||
public ArjArchive(string path) | ||
``` | ||
|
||
| Parameter | Type | Description | | ||
| --- | --- | --- | | ||
| path | String | The path to the archive file. | | ||
|
||
### Exceptions | ||
|
||
| exception | condition | | ||
| --- | --- | | ||
| ArgumentNullException | *path* is null. | | ||
| SecurityException | The caller does not have the required permission to access. | | ||
| ArgumentException | The *path* is empty, contains only white spaces, or contains invalid characters. | | ||
| UnauthorizedAccessException | Access to file *path* is denied. | | ||
| PathTooLongException | The specified *path*, file name, or both exceed the system-defined maximum length. For example, on Windows-based platforms, paths must be less than 248 characters, and file names must be less than 260 characters. | | ||
| NotSupportedException | File at *path* contains a colon (:) in the middle of the string. | | ||
| FileNotFoundException | The file is not found. | | ||
| DirectoryNotFoundException | The specified path is invalid, such as being on an unmapped drive. | | ||
| IOException | The file is already open. | | ||
|
||
## Remarks | ||
|
||
This constructor does not unpack any entry. See [`Extract`](../../arjentryplain/extract/) method for decompressing. | ||
|
||
## Examples | ||
|
||
The following example shows how to extract all of the entries to a directory. | ||
|
||
```csharp | ||
using (var archive = new ArjArchive("archive.arj")) | ||
{ | ||
archive.ExtractToDirectory("C:\extracted"); | ||
} | ||
``` | ||
|
||
### See Also | ||
|
||
* class [ArjArchive](../) | ||
* namespace [Aspose.Zip.ARJ](../../arjarchive/) | ||
* assembly [Aspose.Zip](../../../) | ||
|
||
|
23 changes: 23 additions & 0 deletions
23
...ent/sites/aspose/zip/english/net/aspose.zip.arj/arjarchive/commentary/_index.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
--- | ||
title: ArjArchive.Commentary | ||
second_title: Aspose.ZIP for .NET API Reference | ||
description: ArjArchive property. Gets the commentary | ||
type: docs | ||
weight: 20 | ||
url: /net/aspose.zip.arj/arjarchive/commentary/ | ||
--- | ||
## ArjArchive.Commentary property | ||
|
||
Gets the commentary. | ||
|
||
```csharp | ||
public string Commentary { get; } | ||
``` | ||
|
||
### See Also | ||
|
||
* class [ArjArchive](../) | ||
* namespace [Aspose.Zip.ARJ](../../arjarchive/) | ||
* assembly [Aspose.Zip](../../../) | ||
|
||
|
23 changes: 23 additions & 0 deletions
23
content/sites/aspose/zip/english/net/aspose.zip.arj/arjarchive/dispose/_index.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
--- | ||
title: ArjArchive.Dispose | ||
second_title: Aspose.ZIP for .NET API Reference | ||
description: ArjArchive method. Performs applicationdefined tasks associated with freeing releasing or resetting unmanaged resources | ||
type: docs | ||
weight: 50 | ||
url: /net/aspose.zip.arj/arjarchive/dispose/ | ||
--- | ||
## ArjArchive.Dispose method | ||
|
||
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. | ||
|
||
```csharp | ||
public void Dispose() | ||
``` | ||
|
||
### See Also | ||
|
||
* class [ArjArchive](../) | ||
* namespace [Aspose.Zip.ARJ](../../arjarchive/) | ||
* assembly [Aspose.Zip](../../../) | ||
|
||
|
24 changes: 24 additions & 0 deletions
24
content/sites/aspose/zip/english/net/aspose.zip.arj/arjarchive/entries/_index.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
--- | ||
title: ArjArchive.Entries | ||
second_title: Aspose.ZIP for .NET API Reference | ||
description: ArjArchive property. Gets entries of ArjEntryPlain type constituting the ARJ archive | ||
type: docs | ||
weight: 30 | ||
url: /net/aspose.zip.arj/arjarchive/entries/ | ||
--- | ||
## ArjArchive.Entries property | ||
|
||
Gets entries of [`ArjEntryPlain`](../../arjentryplain/) type constituting the ARJ archive. | ||
|
||
```csharp | ||
public ReadOnlyCollection<ArjEntryPlain> Entries { get; } | ||
``` | ||
|
||
### See Also | ||
|
||
* class [ArjEntryPlain](../../arjentryplain/) | ||
* class [ArjArchive](../) | ||
* namespace [Aspose.Zip.ARJ](../../arjarchive/) | ||
* assembly [Aspose.Zip](../../../) | ||
|
||
|
44 changes: 44 additions & 0 deletions
44
...s/aspose/zip/english/net/aspose.zip.arj/arjarchive/extracttodirectory/_index.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
--- | ||
title: ArjArchive.ExtractToDirectory | ||
second_title: Aspose.ZIP for .NET API Reference | ||
description: ArjArchive method. Extracts all entries to the specified directory | ||
type: docs | ||
weight: 60 | ||
url: /net/aspose.zip.arj/arjarchive/extracttodirectory/ | ||
--- | ||
## ArjArchive.ExtractToDirectory method | ||
|
||
Extracts all entries to the specified directory. | ||
|
||
```csharp | ||
public void ExtractToDirectory(string destinationDirectory) | ||
``` | ||
|
||
| Parameter | Type | Description | | ||
| --- | --- | --- | | ||
| destinationDirectory | String | The directory to extract the entries to. | | ||
|
||
### Exceptions | ||
|
||
| exception | condition | | ||
| --- | --- | | ||
| ArgumentNullException | Thrown when the *destinationDirectory* is null. | | ||
|
||
## Examples | ||
|
||
The following example shows how to extract all entries to a directory: | ||
|
||
```csharp | ||
using (var archive = new ArjArchive(File.OpenRead("archive.arj"))) | ||
{ | ||
archive.ExtractToDirectory("C:\\extracted"); | ||
} | ||
``` | ||
|
||
### See Also | ||
|
||
* class [ArjArchive](../) | ||
* namespace [Aspose.Zip.ARJ](../../arjarchive/) | ||
* assembly [Aspose.Zip](../../../) | ||
|
||
|
23 changes: 23 additions & 0 deletions
23
content/sites/aspose/zip/english/net/aspose.zip.arj/arjarchive/name/_index.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
--- | ||
title: ArjArchive.Name | ||
second_title: Aspose.ZIP for .NET API Reference | ||
description: ArjArchive property. Gets the original name | ||
type: docs | ||
weight: 40 | ||
url: /net/aspose.zip.arj/arjarchive/name/ | ||
--- | ||
## ArjArchive.Name property | ||
|
||
Gets the original name. | ||
|
||
```csharp | ||
public string Name { get; } | ||
``` | ||
|
||
### See Also | ||
|
||
* class [ArjArchive](../) | ||
* namespace [Aspose.Zip.ARJ](../../arjarchive/) | ||
* assembly [Aspose.Zip](../../../) | ||
|
||
|
Oops, something went wrong.