MemoryCache.GetCacheItem(String, String) Method

Definition

Namespace:

System.Runtime.Caching

Assembly:

System.Runtime.Caching.dll

Package:

System.Runtime.Caching v9.0.0-preview.3.24172.9

Source:

MemoryCache.cs

Returns the specified entry from the cache as a CacheItem instance.

public override System.Runtime.Caching.CacheItem GetCacheItem (string key, string regionName = default);

override this.GetCacheItem : string * string -> System.Runtime.Caching.CacheItem

Public Overrides Function GetCacheItem (key As String, Optional regionName As String = Nothing) As CacheItem

Parameters

key

String

A unique identifier for the cache entry to get.

regionName

String

A named region in the cache to which a cache entry was added. Do not pass a value for this parameter. This parameter is null by default, because the MemoryCache class does not implement regions.

Returns

CacheItem

A reference to the cache entry identified by key if the entry exists; otherwise, null.

Exceptions

NotSupportedException

regionName is not null.

ArgumentNullException

key is null.

Remarks

If the cache entry specified by key exists in the cache, the GetCacheItem method returns it as a CacheItem instance. The Key and Value properties of the CacheItem instance will be set. However, the RegionName property will be null, because regions are not implemented in the MemoryCache class.