Codeunit 425 Data Compression
src/System Application/App/Data Compression/src/DataCompression.Codeunit.al192 lines, Copyright (c) Microsoft Corporation. MIT
// ------------------------------------------------------------------------------------------------// Copyright (c) Microsoft Corporation. All rights reserved.// Licensed under the MIT License. See License.txt in the project root for license information.// ------------------------------------------------------------------------------------------------namespace System.IO;using System.Utilities;/// <summary>/// Exposes functionality to provide ability to create, update, read and dispose a binary data compression archive./// This module supports compression and decompression with Zip format and GZip format./// </summary>codeunit 425 "Data Compression"{ Access = Public; InherentEntitlements = X; InherentPermissions = X; var DataCompressionImpl: Codeunit "Data Compression Impl."; /// <summary> /// Creates a new ZipArchive instance. /// </summary> procedure CreateZipArchive() begin DataCompressionImpl.CreateZipArchive(); end; /// <summary> /// Creates a ZipArchive instance from the given InStream. /// </summary> /// <param name="InputInStream">The InStream that contains the content of the compressed archive.</param> /// <param name="OpenForUpdate">Indicates whether the archive should be opened in Update mode. The default (false) indicated the archive will be opened in Read mode.</param> procedure OpenZipArchive(InputInStream: InStream; OpenForUpdate: Boolean) begin DataCompressionImpl.OpenZipArchive(InputInStream, OpenForUpdate); end; /// <summary> /// Creates a ZipArchive instance from the given InStream. /// </summary> /// <param name="InputInStream">The InStream that contains the content of the compressed archive.</param> /// <param name="OpenForUpdate">Indicates whether the archive should be opened in Update mode. The default (false) indicated the archive will be opened in Read mode.</param> /// <param name="EncodingCodePageNumber">Specifies the code page number of the text encoding which is used for the compressed archive entry names in the input stream.</param> procedure OpenZipArchive(InputInStream: InStream; OpenForUpdate: Boolean; EncodingCodePageNumber: Integer) begin DataCompressionImpl.OpenZipArchive(InputInStream, OpenForUpdate, EncodingCodePageNumber); end; /// <summary> /// Creates a ZipArchive instance from the given instance of Temp Blob codeunit. /// </summary> /// <param name="TempBlob">The instance of Temp Blob codeunit that contains the content of the compressed archive.</param> /// <param name="OpenForUpdate">Indicates whether the archive should be opened in Update mode. The default (false) indicated the archive will be opened in Read mode.</param> procedure OpenZipArchive(TempBlob: Codeunit "Temp Blob"; OpenForUpdate: Boolean) begin DataCompressionImpl.OpenZipArchive(TempBlob, OpenForUpdate); end; /// <summary> /// Saves the ZipArchive to the given OutStream. /// </summary> /// <param name="OutputOutStream">The OutStream to which the ZipArchive is saved.</param> procedure SaveZipArchive(OutputOutStream: OutStream) begin DataCompressionImpl.SaveZipArchive(OutputOutStream); end; /// <summary> /// Saves the ZipArchive to the given instance of Temp Blob codeunit. /// </summary> /// <param name="TempBlob">The instance of the Temp Blob codeunit to which the ZipArchive is saved.</param> procedure SaveZipArchive(var TempBlob: Codeunit "Temp Blob") begin DataCompressionImpl.SaveZipArchive(TempBlob); end; /// <summary> /// Disposes the ZipArchive. /// </summary> procedure CloseZipArchive() begin DataCompressionImpl.CloseZipArchive(); end; /// <summary> /// Returns the list of entries for the ZipArchive. /// </summary> /// <param name="EntryList">The list that is populated with the list of entries of the ZipArchive instance.</param> procedure GetEntryList(var EntryList: List of [Text]) begin DataCompressionImpl.GetEntryList(EntryList); end;#if not CLEAN26 /// <summary> /// Extracts an entry from the ZipArchive. /// </summary> /// <param name="EntryName">The name of the ZipArchive entry to be extracted.</param> /// <param name="OutputOutStream">The OutStream to which binary content of the extracted entry is saved.</param> /// <param name="EntryLength">The length of the extracted entry.</param> [Obsolete('This function has been replaced by the function ExtractEntry(EntryName: Text; OutputOutStream: OutStream) which instead returns the entry length.', '23.0')] procedure ExtractEntry(EntryName: Text; OutputOutStream: OutStream; var EntryLength: Integer) begin DataCompressionImpl.ExtractEntry(EntryName, OutputOutStream, EntryLength); end;#endif /// <summary> /// Extracts an entry from the ZipArchive. /// </summary> /// <param name="EntryName">The name of the ZipArchive entry to be extracted.</param> /// <param name="OutputOutStream">The OutStream to which binary content of the extracted entry is saved.</param> /// <returns>The length of the extracted entry.</returns> procedure ExtractEntry(EntryName: Text; OutputOutStream: OutStream) EntryLength: Integer begin DataCompressionImpl.ExtractEntry(EntryName, OutputOutStream, EntryLength); end; /// <summary> /// Extracts an entry from the ZipArchive to a TempBlob instance. /// </summary> /// <param name="EntryName">The name of the ZipArchive entry to be extracted.</param> /// <param name="TempBlob">The TempBlob the uncompressed binary data will be written to.</param> procedure ExtractEntry(EntryName: Text; var TempBlob: Codeunit "Temp Blob"): Integer begin exit(DataCompressionImpl.ExtractEntry(EntryName, TempBlob)); end; /// <summary> /// Adds an entry to the ZipArchive. /// </summary> /// <param name="InStreamToAdd">The InStream that contains the binary content that should be added as an entry in the ZipArchive.</param> /// <param name="PathInArchive">The path that the added entry should have within the ZipArchive.</param> procedure AddEntry(InStreamToAdd: InStream; PathInArchive: Text) begin DataCompressionImpl.AddEntry(InStreamToAdd, PathInArchive); end; /// <summary> /// Removes an entry from the ZipArchive. /// </summary> /// <param name="PathInArchive">The path that the removed entry should have within the ZipArchive.</param> procedure RemoveEntry(PathInArchive: Text) begin DataCompressionImpl.RemoveEntry(PathInArchive); end; /// <summary> /// Determines whether the given InStream is compressed with GZip. /// </summary> /// <param name="InStream">An InStream that contains binary content.</param> /// <returns>Returns true if and only if the given InStream is compressed with GZip</returns> procedure IsGZip(InStream: InStream): Boolean begin exit(DataCompressionImpl.IsGZip(InStream)); end; /// <summary> /// Determines whether the given InStream is compressed with Zip. /// </summary> /// <param name="InStream">An InStream that contains binary content.</param> /// <returns>Returns true if and only if the given InStream is compressed with Zip</returns> procedure IsZip(InStream: InStream): Boolean begin exit(DataCompressionImpl.IsZip(InStream)); end; /// <summary> /// Compresses a stream with GZip algorithm. /// <param name="InputInStream">The InStream that contains the content that should be compressed.</param> /// <param name="CompressedOutStream">The OutStream into which the compressed stream is copied to.</param> /// </summary> procedure GZipCompress(InputInStream: InStream; CompressedOutStream: OutStream) begin DataCompressionImpl.GZipCompress(InputInStream, CompressedOutStream); end; /// <summary> /// Decompresses a GZipStream. /// <param name="InputInStream">The InStream that contains the content that should be decompressed.</param> /// <param name="DecompressedOutStream">The OutStream into which the decompressed stream is copied to.</param> /// </summary> procedure GZipDecompress(InputInStream: InStream; DecompressedOutStream: OutStream) begin DataCompressionImpl.GZipDecompress(InputInStream, DecompressedOutStream); end;}