CacheEntryUpdateArguments Class
[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]
Provides information about a cache entry that will be removed from the cache.
Namespace: System.Runtime.Caching
Assembly: System.Runtime.Caching (in System.Runtime.Caching.dll)
The CacheEntryUpdateArguments type exposes the following members.
| Name | Description | |
|---|---|---|
|
CacheEntryUpdateArguments | Initializes a new instance of the CacheEntryUpdateArguments class. |
| Name | Description | |
|---|---|---|
|
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. |
| Name | Description | |
|---|---|---|
|
|
Equals(Object) | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
|
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
|
|
GetHashCode | Serves as a hash function for a particular type. (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.) |
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 Implementers
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.
Windows 8 Release Preview, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 SP2, Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
