CacheEntryUpdateArguments Class

Definition

Namespace:

System.Runtime.Caching

Assembly:

System.Runtime.Caching.dll

Package:

System.Runtime.Caching v9.0.0

Source:

CacheEntryUpdateArguments.cs

Provides information about a cache entry that will be removed from the cache.

public ref class CacheEntryUpdateArguments

public class CacheEntryUpdateArguments

type CacheEntryUpdateArguments = class

Public Class CacheEntryUpdateArguments

Inheritance

Object

CacheEntryUpdateArguments

Remarks

The arguments in the CacheEntryUpdateArguments class contain details about an entry that the cache implementation is about to remove. The arguments include a key to the cache entry, a reference to the ObjectCache instance that the entry will be removed from, a reason for the removal, and the region name in the cache that contains the entry. The constructor of the CacheEntryUpdateArguments class uses these arguments to create a new instance of the class.

A CacheEntryUpdateArguments object is passed to a CacheEntryUpdateCallback handler, which notifies the cache about the entry to remove.

Notes to Inheritors

A callback handler must notify the cache implementation whether to insert a replacement entry into the cache in place of the cache entry that is about to be removed. If you want to exchange cache entries, you must assign a value other than null to the UpdatedCacheItem property. Cache implementations will interpret a null value for the UpdatedCacheItem property as a notice that the current cache entry should be removed but not replaced.

Constructors

CacheEntryUpdateArguments(ObjectCache, CacheEntryRemovedReason, String, String)

Initializes a new instance of the CacheEntryUpdateArguments class.

Properties

Key	Gets the unique identifier for a cache entry that is about to be removed.
RegionName	Gets the name of a region in the cache that contains a cache entry.
RemovedReason	Gets the reason that a cache entry is about to be removed from the cache.
Source	Gets a reference to the ObjectCache instance that contains a cache entry that is about to be removed.
UpdatedCacheItem	Gets or sets the value of CacheItem entry that is used to update the cache object.
UpdatedCacheItemPolicy	Gets or sets the cache eviction or expiration policy of the CacheItem entry that is updated.

Methods

Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetType()	Gets the Type of the current instance. (Inherited from Object)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ToString()	Returns a string that represents the current object. (Inherited from Object)

See also

• CacheEntryChangeMonitor
• CacheEntryUpdateCallback