• Product Bundles

    DevCraft

    All Telerik .NET tools and Kendo UI JavaScript components in one package. Now enhanced with:

    • NEW: Design Kits for Figma
    • Online Training
    • Document Processing Library
    • Embedded Reporting for web and desktop
    Web
    Kendo UI UI for jQuery UI for Angular UI for React UI for Vue UI for ASP.NET AJAX UI for ASP.NET MVC UI for ASP.NET Core UI for Blazor UI for Silverlight UI for PHP UI for JSP
    Mobile
    UI for .NET MAUI UI for Xamarin
    Document Management
    Telerik Document Processing
    Desktop
    UI for .NET MAUI UI for WinUI UI for WinForms UI for WPF UI for UWP
    Reporting & Mocking
    Telerik Reporting Telerik Report Server Telerik JustMock
    Automated Testing
    Test Studio Test Studio Dev Edition
    CMS
    Sitefinity
    UI/UX Design
    Unite UX
    Debugging
    Fiddler Fiddler Everywhere Fiddler Classic Fiddler Jam FiddlerCap FiddlerCore
    Extended Reality
    UI for Unity XR
    Free Tools
    JustAssembly JustDecompile VB.NET to C# Converter Testing Framework
    View all products
  • Overview
  • Demos
    • What's New
    • Roadmap
    • Release History
  • Docs & Support
  • Pricing
  • Search
  • Shopping cart
    • Account Overview
    • Your Licenses
    • Support Center
    • Forum Profile
    • Payment Methods
    • Edit Profile
    • Log out
  • Login
  • Contact Us
  • Try now

Interface IStorage

Represents a storage object used from the reporting engine to store internal state and cache rendered reports.

Namespace: Telerik.Reporting.Cache.Interfaces
Assembly: Telerik.Reporting.dll

Syntax

public interface IStorage
Remarks

Implement this interface using a storage technology of your favor in order to have your reporting engine instance storing its state and cached reports in it.
The storage may store single values - string or byte array, and a set of unordered string values.
The storage also enables serialized access to the stored resources by implementing a lock mechanism.

Methods

AcquireLock(String)

Acquires a lock on a named resource.

Declaration
IDisposable AcquireLock(string key)
Parameters
System.String key

The name of the lock. When a lock with particular key is acquired, a subsequent call on AcuireLock with the same key should wait until the original lock is released (disposed).

Returns
System.IDisposable

A disposable lock object. When disposed from the lock object owner, the lock of the used key is released.

Remarks

Acquires a lock on a named resource and returns a disposable lock object. When the lock object owner disposes it, the lock is released.

AddInSet(String, String)

Adds a single string value to a set of values denoted from the given key.

Declaration
void AddInSet(string key, string value)
Parameters
System.String key

The key that denotes the stored set value.

System.String value

The value that is added to the set.

Remarks

If a set with the given key does not exist in the storage, such set is created and the value is added as its member.

Delete(String)

Deletes a key with its value (string or byte array) from the storage.

Declaration
void Delete(string key)
Parameters
System.String key

The key that denotes the stored value that should be removed.

DeleteInSet(String, String)

Deletes a single string value from a set of values denoted from the given key.

Declaration
bool DeleteInSet(string key, string value)
Parameters
System.String key

The key that denotes the stored set value.

System.String value

The value that should be deleted from the given set.

Returns
System.Boolean

True if set with the given key is found and it contained the given value before deleted. Otherwise false.

DeleteSet(String)

Deletes set of values denoted by the given key.

Declaration
void DeleteSet(string key)
Parameters
System.String key

The key that denotes the stored set.

Exists(String)

Retrieves a value indicating if a single value (string or byte array) exists in the storage.

Declaration
bool Exists(string key)
Parameters
System.String key

The key that denotes the stored value.

Returns
System.Boolean

True if the key with its value exists in the storage, otherwise false.

ExistsInSet(String, String)

Retrieves a value indicating if a set of values exists in the storage.

Declaration
bool ExistsInSet(string key, string value)
Parameters
System.String key

The key that denotes the stored set value.

System.String value

Returns
System.Boolean

True if the key with its value exists in the storage, otherwise false.

GetAllMembersInSet(String)

Retrieves all members in a set of string values.

Declaration
IEnumerable<string> GetAllMembersInSet(string key)
Parameters
System.String key

The key that denotes the stored set value.

Returns
System.Collections.Generic.IEnumerable<System.String>

An enumerable retrieving each value of the set denoted from the given key.

GetBytes(String)

Retrieves a byte array value stored under particular key.

Declaration
byte[] GetBytes(string key)
Parameters
System.String key

The key that denotes the stored byte array value.

Returns
System.Byte[]

The byte array value stored under the given key. If no such key is found, null (Nothing).

GetCountInSet(String)

Retrieves the count of the values in a set value stored in the storage.

Declaration
long GetCountInSet(string key)
Parameters
System.String key

The key that denotes the stored set value.

Returns
System.Int64

The count of the values in the set. If no such set exists, zero.

GetString(String)

Retrieves a string value stored under particular key.

Declaration
string GetString(string key)
Parameters
System.String key

The key that denotes the stored string value.

Returns
System.String

The string value stored under the given key. If no such key is found, null (Nothing).

SetBytes(String, Byte[])

Stores a byte array value under particular key.

Declaration
void SetBytes(string key, byte[] value)
Parameters
System.String key

The key that denotes the stored byte array value.

System.Byte[] value

The value that is stored.

SetString(String, String)

Stores a string value under particular key.

Declaration
void SetString(string key, string value)
Parameters
System.String key

The key that denotes the stored string value.

System.String value

The value that is stored.

Was this article helpful?

Tell us how we can improve this article

Skip
Getting Started
  • Install Now
  • Online Demos
Support Resources
  • Documentation
  • Knowledge Base
  • Videos
  • Reporting Samples Repository
  • Reporting Release History
Community
  • Forums
  • Blogs
  • Reporting Feedback Portal

Copyright © 2018 Progress Software Corporation and/or its subsidiaries or affiliates.
All Rights Reserved.

Progress, Telerik, and certain product names used herein are trademarks or registered trademarks of Progress Software Corporation and/or one of its subsidiaries or affiliates in the U.S. and/or other countries. See Trademarks for appropriate markings.