Codeunit 4102 Temp Blob List
src/System Application/App/BLOB Storage/src/TempBlobList.Codeunit.al130 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.Utilities;/// <summary>/// The interface for storing sequences of variables, each of which stores BLOB data./// </summary>codeunit 4102 "Temp Blob List"{ Access = Public; InherentEntitlements = X; InherentPermissions = X; var TempBlobListImpl: Codeunit "Temp Blob List Impl."; /// <summary> /// Check if an element with the given index exists. /// </summary> /// <param name="Index">The index of the TempBlob in the list.</param> /// <returns>True if an element at the given index exists.</returns> procedure Exists(Index: Integer): Boolean begin exit(TempBlobListImpl.Exists(Index)); end; /// <summary> /// Returns the number of elements in the list. /// </summary> /// <returns>The number of elements in the list.</returns> procedure "Count"(): Integer begin exit(TempBlobListImpl.Count()); end; /// <summary> /// Get an element from the list at any given position. /// </summary> /// <error>The index is larger than the number of elements in the list or less than one.</error> /// <param name="Index">The index of the TempBlob in the list.</param> /// <param name="TempBlob">The TempBlob to return.</param> /// <returns>An element from the list at any given position.</returns> procedure Get(Index: Integer; var TempBlob: Codeunit "Temp Blob") begin TempBlobListImpl.Get(Index, TempBlob); end; /// <summary> /// Set an element at the given index from the parameter TempBlob. /// </summary> /// <error>The index is larger than the number of elements in the list or less than one.</error> /// <param name="Index">The index of the TempBlob in the list.</param> /// <param name="TempBlob">The TempBlob to set.</param> /// <returns>True if successful.</returns> procedure Set(Index: Integer; TempBlob: Codeunit "Temp Blob"): Boolean begin exit(TempBlobListImpl.Set(Index, TempBlob)); end; /// <summary> /// Remove the element at a specified location from a non-empty list. /// </summary> /// <error>The index is larger than the number of elements in the list or less than one.</error> /// <param name="Index">The index of the TempBlob in the list.</param> /// <returns>True if successful.</returns> procedure RemoveAt(Index: Integer): Boolean begin exit(TempBlobListImpl.RemoveAt(Index)); end; /// <summary> /// Remove a number of elements starting from a specified location from a non-empty list. /// </summary> /// <error>The index is larger than the number of elements in the list or less than one.</error> /// <error>The element count is less than one.</error> /// <param name="Index">The index of the first element to be deleted.</param> /// <param name="ElementCount">The number of elements to be deleted.</param> /// <returns>True if successful.</returns> procedure RemoveRange(Index: Integer; ElementCount: Integer): Boolean begin exit(TempBlobListImpl.RemoveRange(Index, ElementCount)); end; /// <summary> /// Return true if the list is empty, otherwise return false. /// </summary> /// <returns>True if the list is empty.</returns> procedure IsEmpty(): Boolean begin exit(TempBlobListImpl.IsEmpty()); end; /// <summary> /// Adds a TempBlob to the end of the list. /// </summary> /// <param name="TempBlob">The TempBlob to add.</param> /// <returns>True if successful.</returns> procedure Add(TempBlob: Codeunit "Temp Blob"): Boolean begin exit(TempBlobListImpl.Add(TempBlob)); end; /// <summary> /// Adds the elements of the specified TempBlobList to the end of the current TempBlobList object. /// </summary> /// <param name="TempBlobList">The TempBlob list to add.</param> /// <returns>True if successful.</returns> procedure AddRange(TempBlobList: Codeunit "Temp Blob List"): Boolean begin exit(TempBlobListImpl.AddRange(TempBlobList)); end; /// <summary> /// Get a copy of a range of elements in the list starting from index, /// </summary> /// <error>The index is larger than the number of elements in the list or less than one.</error> /// <error>The range to return in not within the range of the list.</error> /// <param name="Index">The index of the first object.</param> /// <param name="ElemCount">The number of objects to be returned.</param> /// <param name="TempBlobListOut">The TempBlobList to be returned passed as a VAR.</param> procedure GetRange(Index: Integer; ElemCount: Integer; var TempBlobListOut: Codeunit "Temp Blob List") begin TempBlobListImpl.GetRange(Index, ElemCount, TempBlobListOut); end;}