MemoryCache.Remove Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Removes the specified item from the cache.
Overloads
Remove(String, String) |
Removes a cache entry from the cache. |
Remove(String, CacheEntryRemovedReason, String) |
Removes a cache entry from the cache using the reason. |
Remove(String, String)
- Source:
- MemoryCache.cs
- Source:
- MemoryCache.cs
- Source:
- MemoryCache.cs
Removes a cache entry from the cache.
public override object Remove (string key, string regionName = default);
override this.Remove : string * string -> obj
Public Overrides Function Remove (key As String, Optional regionName As String = Nothing) As Object
Parameters
- key
- String
A unique identifier for the cache entry to remove.
- 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
If the entry is found in the cache, the removed cache entry; otherwise, null
.
Exceptions
regionName
is not null
.
key
is null
.
Remarks
If the entry specified by key
exists in the cache, removing the item triggers any associated change monitors. If the removed item was associated with a CacheItemUpdateCallback object or a CacheItemRemovedCallback object, the reason passed to the callback is Removed.
Applies to
Remove(String, CacheEntryRemovedReason, String)
- Source:
- MemoryCache.cs
- Source:
- MemoryCache.cs
- Source:
- MemoryCache.cs
Removes a cache entry from the cache using the reason.
public object Remove (string key, System.Runtime.Caching.CacheEntryRemovedReason reason, string regionName = default);
override this.Remove : string * System.Runtime.Caching.CacheEntryRemovedReason * string -> obj
Public Function Remove (key As String, reason As CacheEntryRemovedReason, Optional regionName As String = Nothing) As Object
Parameters
- key
- String
A unique identifier for the cache entry to remove.
- reason
- CacheEntryRemovedReason
The reason the item was removed.
- 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
If the entry is found in the cache, the removed cache entry; otherwise, null
.