Skip to content

Commit

Permalink
Update file(s) "/." from "aspose-zip/Aspose.ZIP-API-References"
Browse files Browse the repository at this point in the history
  • Loading branch information
Eugene85 committed Jan 28, 2025
1 parent d5490dd commit ac079a0
Show file tree
Hide file tree
Showing 171 changed files with 787 additions and 161 deletions.
1 change: 1 addition & 0 deletions content/sites/aspose/zip/english/net/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ is_root: true
| --- | --- |
| [Aspose.Zip](./aspose.zip/) | The Zip namespace contains classes which represent zip archive and common archive related entities. |
| [Aspose.Zip.ArchiveInfo](./aspose.zip.archiveinfo/) | The ArchiveInfo namespace contains classes which represent archive info related entities. |
| [Aspose.Zip.ARJ](./aspose.zip.arj/) | The ARJ namespace contains classes which represent ARJ related entities. |
| [Aspose.Zip.Bzip2](./aspose.zip.bzip2/) | The Bzip2 namespace contains classes which represent bzip2 archive related entities. |
| [Aspose.Zip.Cab](./aspose.zip.cab/) | The Cab namespace contains classes which represent Cab archive related entities. |
| [Aspose.Zip.Cpio](./aspose.zip.cpio/) | The Cpio namespace contains classes which represent cpio archive related entities. |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Enum ArchiveFormat
second_title: Aspose.ZIP for .NET API Reference
description: Aspose.Zip.ArchiveInfo.ArchiveFormat enum. Supported archive formats
type: docs
weight: 60
weight: 80
url: /net/aspose.zip.archiveinfo/archiveformat/
---
## ArchiveFormat enumeration
Expand Down Expand Up @@ -38,6 +38,7 @@ public enum ArchiveFormat
| Zstandard | `17` | Zstandard archive ([`ZstandardArchive`](../../aspose.zip.zstandard/zstandardarchive/)). |
| Iso | `18` | Iso archive ([`IsoArchive`](../../aspose.zip.iso/isoarchive/)). |
| Lha | `19` | Lha archive ([`LhaArchive`](../../aspose.zip.lha/lhaarchive/) |
| Arj | `20` | Lha archive ([`ArjArchive`](../../aspose.zip.arj/arjarchive/) |

### See Also

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Class ArchiveFormatInfo
second_title: Aspose.ZIP for .NET API Reference
description: Aspose.Zip.ArchiveInfo.ArchiveFormatInfo class. Represents information about the archive format
type: docs
weight: 70
weight: 90
url: /net/aspose.zip.archiveinfo/archiveformatinfo/
---
## ArchiveFormatInfo class
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Class ArchiveInstanceInfo
second_title: Aspose.ZIP for .NET API Reference
description: Aspose.Zip.ArchiveInfo.ArchiveInstanceInfo class. Represents information about the archive instance
type: docs
weight: 80
weight: 100
url: /net/aspose.zip.archiveinfo/archiveinstanceinfo/
---
## ArchiveInstanceInfo class
Expand Down
18 changes: 18 additions & 0 deletions content/sites/aspose/zip/english/net/aspose.zip.arj/_index.md
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. |


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](../../)


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](../../../)


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](../../../)


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](../../../)


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](../../../)


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](../../../)


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](../../../)


Loading

0 comments on commit ac079a0

Please sign in to comment.