New to Telerik ReportingStart a free 30-day trial

IStorage

Interface

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

Definition

Namespace:Telerik.Reporting.Cache.Interfaces

Assembly:Telerik.Reporting.dll

Syntax:

C#
public interface IStorage

Derived Classes: CacheStorageDatabaseStorageFileStorageMsSqlServerStorageRedisStorage

Methods

Acquires a lock on a named resource.

C#
IDisposable AcquireLock(string key)
Parameters:keystring

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:

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.

Acquires a lock on a named resource for reading, using less-restrictive locking mechanism.

C#
IDisposable AcquireReadLock(string key)
Parameters:keystringReturns:

IDisposable

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.

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

C#
void AddInSet(string key, string value)
Parameters:keystring

The key that denotes the stored set value.

valuestring

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.

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

C#
void Delete(string key)
Parameters:keystring

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

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

C#
bool DeleteInSet(string key, string value)
Parameters:keystring

The key that denotes the stored set value.

valuestring

The value that should be deleted from the given set.

Returns:

bool

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

Deletes set of values denoted by the given key.

C#
void DeleteSet(string key)
Parameters:keystring

The key that denotes the stored set.

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

C#
bool Exists(string key)
Parameters:keystring

The key that denotes the stored value.

Returns:

bool

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

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

C#
bool ExistsInSet(string key, string value)
Parameters:keystring

The key that denotes the stored set value.

valuestring

The stored set value.

Returns:

bool

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

GetAllMembersInSet(string)

IEnumerable<string>

Retrieves all members in a set of string values.

C#
IEnumerable<string> GetAllMembersInSet(string key)
Parameters:keystring

The key that denotes the stored set value.

Returns:

IEnumerable<string>

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

Retrieves a byte array value stored under particular key.

C#
byte[] GetBytes(string key)
Parameters:keystring

The key that denotes the stored byte array value.

Returns:

byte[]

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

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

C#
long GetCountInSet(string key)
Parameters:keystring

The key that denotes the stored set value.

Returns:

long

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

Retrieves a string value stored under particular key.

C#
string GetString(string key)
Parameters:keystring

The key that denotes the stored string value.

Returns:

string

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

Stores a byte array value under particular key.

C#
void SetBytes(string key, byte[] value)
Parameters:keystring

The key that denotes the stored byte array value.

valuebyte[]

The value that is stored.

Stores a string value under particular key.

C#
void SetString(string key, string value)
Parameters:keystring

The key that denotes the stored string value.

valuestring

The value that is stored.