<?xml version="1.0" encoding="utf-8"?>
<doc>
<assembly>
<name>Microsoft.ApplicationServer.Caching.Client</name>
</assembly>
<members>
<member name="T:Microsoft.ApplicationServer.Caching.DataCache">
<summary>The object that is used by cache-enabled applications for storing and retrieving objects from the cache cluster. An instance of this object is referred to as the cache client.</summary>
</member>
<member name="M:Microsoft.ApplicationServer.Caching.DataCache.Add(System.String,System.Object)">
<summary>Adds an object to the cache.</summary>
<returns>A <see cref="T:Microsoft.ApplicationServer.Caching.DataCacheItemVersion"></see> object that represents the version of the object saved to the cache under the key value.</returns>
<param name="key">A unique value that is used to store and retrieve the object from the cache.</param>
<param name="value">The object saved to the cache cluster.</param>
</member>
<member name="M:Microsoft.ApplicationServer.Caching.DataCache.Add(System.String,System.Object,System.Collections.Generic.IEnumerable{Microsoft.ApplicationServer.Caching.DataCacheTag})">
<summary>Adds an object to the cache. This method enables associating tags with the cached object.</summary>
<returns>A <see cref="T:Microsoft.ApplicationServer.Caching.DataCacheItemVersion"></see> object that represents the version of the object saved to the cache under the key value.</returns>
<param name="key">A unique value that is used to store and retrieve the object from the cache.</param>
<param name="value">The object saved to the cache cluster.</param>
<param name="tags">An array of <see cref="T:Microsoft.ApplicationServer.Caching.DataCacheTag"></see> objects to associate with the cached object.</param>
</member>
<member name="M:Microsoft.ApplicationServer.Caching.DataCache.Add(System.String,System.Object,System.String)">
<summary>Adds an object to a region in the cache.</summary>
<returns>A <see cref="T:Microsoft.ApplicationServer.Caching.DataCacheItemVersion"></see> object that represents the version of the object saved to the cache under the key value.</returns>
<param name="region">The name of the region to save the object in.</param>
<param name="key">A unique value that is used to store and retrieve the object from the cache.</param>
<param name="value">The object saved to the cache cluster.</param>
</member>
<member name="M:Microsoft.ApplicationServer.Caching.DataCache.Add(System.String,System.Object,System.TimeSpan)">
<summary>Adds an object to the cache. This method provides the ability to specify when the object should be expired.</summary>
<returns>A <see cref="T:Microsoft.ApplicationServer.Caching.DataCacheItemVersion"></see> object that represents the version of the object saved to the cache under the key value.</returns>
<param name="key">A unique value that is used to store and retrieve the object from the cache.</param>
<param name="value">The object saved to the cache cluster.</param>
<param name="timeout">The amount of time the object should reside in the cache before expiration.</param>
</member>
<member name="M:Microsoft.ApplicationServer.Caching.DataCache.Add(System.String,System.Object,System.Collections.Generic.IEnumerable{Microsoft.ApplicationServer.Caching.DataCacheTag},System.String)">
<summary>Adds an object to a region in the cache. This method enables association of tags with objects in the cache.</summary>
<returns>A <see cref="T:Microsoft.ApplicationServer.Caching.DataCacheItemVersion"></see> object that represents the version of the object saved to the cache under the key value.</returns>
<param name="region">The name of the region to save the object in.</param>
<param name="key">A unique value that is used to store and retrieve the object from the cache.</param>
<param name="value">The object saved to the cache cluster.</param>
<param name="tags">An array of <see cref="T:Microsoft.ApplicationServer.Caching.DataCacheTag"></see> objects to associate with the cached object.</param>
</member>
<member name="M:Microsoft.ApplicationServer.Caching.DataCache.Add(System.String,System.Object,System.TimeSpan,System.Collections.Generic.IEnumerable{Microsoft.ApplicationServer.Caching.DataCacheTag})">
<summary>Adds an object to the cache. This method enables associating tags with the cached object and specifying when the object should be expired.</summary>
<returns>A <see cref="T:Microsoft.ApplicationServer.Caching.DataCacheItemVersion"></see> object that represents the version of the object saved to the cache under the key value.</returns>
<param name="key">A unique value that is used to store and retrieve the object from the cache.</param>
<param name="value">The object saved to the cache cluster.</param>
<param name="timeout">The amount of time that the object should reside in the cache before expiration.</param>
<param name="tags">An array of <see cref="T:Microsoft.ApplicationServer.Caching.DataCacheTag"></see> objects to associate with the cached object.</param>
</member>
<member name="M:Microsoft.ApplicationServer.Caching.DataCache.Add(System.String,System.Object,System.TimeSpan,System.String)">
<summary>Adds an object to a region in the cache. This method provides the ability to specify when the object should be expired.</summary>
<returns>A <see cref="T:Microsoft.ApplicationServer.Caching.DataCacheItemVersion"></see>object that represents the version of the object saved to the cache under the key value.</returns>
<param name="region">The name of the region to save the object.</param>
<param name="key">A unique value that is used to store and retrieve the object from the cache.</param>
<param name="value">The object saved to the cache cluster.</param>
<param name="timeout">The amount of time that the object should reside in the cache before expiration.</param>
</member>
<member name="M:Microsoft.ApplicationServer.Caching.DataCache.Add(System.String,System.Object,System.TimeSpan,System.Collections.Generic.IEnumerable{Microsoft.ApplicationServer.Caching.DataCacheTag},System.String)">
<summary>Adds an object to a region in the cache. This method enables associating tags with the cached object and specifying when the object should be expired.</summary>
<returns>A <see cref="T:Microsoft.ApplicationServer.Caching.DataCacheItemVersion"></see> object that represents the version of the object saved to the cache under the key value.</returns>
<param name="region">The name of the region to save the object.</param>
<param name="key">A unique value that is used to store and retrieve the object from the cache.</param>
<param name="value">The object saved to the cache cluster.</param>
<param name="timeout">The amount of time that the object should reside in the cache before expiration.</param>
<param name="tags">An array of <see cref="T:Microsoft.ApplicationServer.Caching.DataCacheTag"></see> objects to associate with the cached object.</param>
</member>
<member name="M:Microsoft.ApplicationServer.Caching.DataCache.AddCacheLevelBulkCallback(Microsoft.ApplicationServer.Caching.DataCacheBulkNotificationCallback)">
<summary>Adds a bulk cache notification callback for cache operations occurring on all regions and items.</summary>
<returns>A <see cref="T:Microsoft.ApplicationServer.Caching.DataCacheNotificationDescriptor"></see> object used to identify the cache bulk notification callback.</returns>
<param name="clientCallback">The name of the method you want to invoke when these notifications occur.</param>
</member>
<member name="M:Microsoft.ApplicationServer.Caching.DataCache.AddCacheLevelCallback(Microsoft.ApplicationServer.Caching.DataCacheOperations,Microsoft.ApplicationServer.Caching.DataCacheNotificationCallback)">
<summary>Adds a cache notification callback for cache operations occurring on all regions and items.</summary>
<returns>A <see cref="T:Microsoft.ApplicationServer.Caching.DataCacheNotificationDescriptor"></see> object used to identify the cache notification callback.</returns>
<param name="clientCallback">The name of the method you want to invoke when these notifications occur.</param>
<param name="filter">The type of cache operation(s) that will trigger cache notifications.</param>
</member>
<member name="M:Microsoft.ApplicationServer.Caching.DataCache.AddFailureNotificationCallback(Microsoft.ApplicationServer.Caching.DataCacheFailureNotificationCallback)">
<summary>Adds a failure notification callback, for notifications indicating that a client has missed one or more cache notifications.</summary>
<returns>A <see cref="T:Microsoft.ApplicationServer.Caching.DataCacheNotificationDescriptor"></see> object used to identify the cache notification callback.</returns>
<param name="failureCallback">The name of the method that you want to invoke when the failure notification occurs.</param>
</member>
<member name="M:Microsoft.ApplicationServer.Caching.DataCache.AddItemLevelCallback(System.String,Microsoft.ApplicationServer.Caching.DataCacheOperations,Microsoft.ApplicationServer.Caching.DataCacheNotificationCallback)">
<summary>Adds a cache notification callback for cache operations occurring on one specific item that is not stored in a region.</summary>
<returns>A <see cref="T:Microsoft.ApplicationServer.Caching.DataCacheNotificationDescriptor"></see> object used to identify the cache notification callback.</returns>
<param name="clientCallback">The name of the method you want to invoke when these notifications occur.</param>
<param name="key">The key used to store the object in the cache.</param>
<param name="filter">The type of cache operation(s) that will trigger cache notifications.</param>
</member>
<member name="M:Microsoft.ApplicationServer.Caching.DataCache.AddItemLevelCallback(System.String,Microsoft.ApplicationServer.Caching.DataCacheOperations,Microsoft.ApplicationServer.Caching.DataCacheNotificationCallback,System.String)">
<summary>Adds a cache notification callback for cache operations occurring on one specific item that is stored in region.</summary>
<returns>A <see cref="T:Microsoft.ApplicationServer.Caching.DataCacheNotificationDescriptor"></see> object used to identify the cache notification callback.</returns>
<param name="clientCallback">The name of the method you want to invoke when these notifications occur.</param>
<param name="key">The key used to store the object in the cache.</param>
<param name="region">The name of the region where the object is stored.</param>
<param name="filter">The type of cache operation(s) that will trigger cache notifications.</param>
</member>
<member name="M:Microsoft.ApplicationServer.Caching.DataCache.AddRegionLevelCallback(System.String,Microsoft.ApplicationServer.Caching.DataCacheOperations,Microsoft.ApplicationServer.Caching.DataCacheNotificationCallback)">
<summary>Adds a cache notification callback for cache operations occurring on one specific region.</summary>
<returns>A <see cref="T:Microsoft.ApplicationServer.Caching.DataCacheNotificationDescriptor"></see> object used to identify the cache notification callback.</returns>
<param name="region">The name of the region for which the specified item or region operations can trigger cache notifications.</param>
<param name="clientCallback">The name of the method you want to invoke when these notifications occur.</param>
<param name="filter">The type of cache operation(s) that will trigger cache notifications.</param>
</member>
<member name="M:Microsoft.ApplicationServer.Caching.DataCache.BulkGet(System.Collections.Generic.IEnumerable{System.String},System.String)">
<summary>Returns objects for the specified keys from the specified region of the cache.</summary>
<returns>Returns an <see cref="T:System.Collections.Generic.IEnumerable`1"></see> object with a list of key and value pairs.</returns>
<param name="region">Name of the region, cannot be null.</param>
<param name="keys">List of keys for the objects to retrieve, cannot be null.</param>
</member>
<member name="M:Microsoft.ApplicationServer.Caching.DataCache.ClearRegion(System.String)">
<summary>Deletes all objects in the specified region.</summary>
<param name="region">The name of the region whose objects are removed.</param>
</member>
<member name="M:Microsoft.ApplicationServer.Caching.DataCache.CreateRegion(System.String)">
<summary>Creates a region.</summary>
<returns>Returns <see cref="T:System.Boolean"></see>.</returns>
<param name="region">The name of the region that is created.</param>
</member>
<member name="M:Microsoft.ApplicationServer.Caching.DataCache.Get(System.String)">
<summary>Gets an object from the cache using the specified key.</summary>
<returns>The object that was cached by using the specified key. Null is returned if the key does not exist.</returns>
<param name="key">The unique value that is used to identify the object in the cache.</param>
</member>
<member name="M:Microsoft.ApplicationServer.Caching.DataCache.Get(System.String,Microsoft.ApplicationServer.Caching.DataCacheItemVersion@)">
<summary>Gets an object from the cache using the specified key. You may also provide the version to obtain a specific version of a key, if that version is still the most current in the cache.</summary>
<returns>The object that was cached by using the specified key. Null is returned if the key does not exist. Even if the key does exist, may also be returned because the object has been updated to a new version.</returns>
<param name="version">The version of the desired object. If this parameter is null, the version of the current object is retrieved.</param>
<param name="key">The unique value that is used to identify the object in the cache.</param>
</member>
<member name="M:Microsoft.ApplicationServer.Caching.DataCache.Get(System.String,System.String)">
<summary>Gets an object from the specified region by using the specified key.</summary>
<returns>The object that was cached by using the specified key. Null is returned if the key does not exist.</returns>
<param name="region">The name of the region where the object resides.</param>
<param name="key">The unique value that is used to identify the object in the region.</param>
</member>
<member name="M:Microsoft.ApplicationServer.Caching.DataCache.Get(System.String,Microsoft.ApplicationServer.Caching.DataCacheItemVersion@,System.String)">
<summary>Gets an object from the specified region by using the specified key. You may also provide the version to obtain the specific version of a key, if that version is still the most current in the region.</summary>
<returns>The object that was cached by using the specified key. Null is returned if the key does not exist. Even if the key does exist, may also be returned because the object has been updated to a new version.</returns>
<param name="version">The version of the desired object. If this parameter is null, the version of the current object is retrieved.</param>
<param name="region">The name of the region where the object resides.</param>
<param name="key">The unique value that is used to identify the object in the region.</param>
</member>
<member name="M:Microsoft.ApplicationServer.Caching.DataCache.GetAndLock(System.String,System.TimeSpan,Microsoft.ApplicationServer.Caching.DataCacheLockHandle@)">
<summary>Locks the key if the key is present and it is not locked and returns the object corresponding to the key.</summary>
<returns>Returns <see cref="T:System.Object"></see> matching the specified key parameter if the <see cref="T:System.Object"></see> is present and is not locked. An error “Object does not exist”, error code ERRCA0008 is thrown if the key does not exist. Create objects based on the referenced key to resolve this error.An error “Object in cache is already locked”, error code ERRCA0013 is thrown if the key is already locked and will be inaccessible until it is unlocked by the locking client.</returns>
<param name="key">The unique value that is used to identify the object in the cache.</param>
<param name="lockHandle">The <see cref="T:Microsoft.ApplicationServer.Caching.DataCacheLockHandle"></see> object required to unlock the object. The lockHandle output parameter is passed by reference.</param>
<param name="timeout">The amount of time that the object should remain locked.</param>
</member>
<member name="M:Microsoft.ApplicationServer.Caching.DataCache.GetAndLock(System.String,System.TimeSpan,Microsoft.ApplicationServer.Caching.DataCacheLockHandle@,System.Boolean)">
<summary>Lock the key if key is present and it is not locked by any clients and returns the object corresponding to the key.</summary>
<returns>Returns <see cref="T:System.Object"></see> matching the specified key parameter if the <see cref="T:System.Object"></see> is present and is not locked. An error “Object does not exist”, error code ERRCA0008 is thrown if the key does not exist. Create objects based on the referenced key to resolve this error.An error “Object in cache is already locked”, error code ERRCA0013 is thrown if the key is already locked and will be inaccessible until it is unlocked by the locking client.</returns>
<param name="key">The unique value that is used to identify the object in the region.</param>
<param name="lockHandle">The <see cref="T:Microsoft.ApplicationServer.Caching.DataCacheLockHandle"></see> object required to unlock the object. The lockHandle output parameter is passed by reference.</param>
<param name="forceLock">If forceLock is true, key is locked irrespective of key-value pair presence in cache.</param>
<param name="timeout">The amount of time that object remains locked.</param>
</member>
<member name="M:Microsoft.ApplicationServer.Caching.DataCache.GetAndLock(System.String,System.TimeSpan,Microsoft.ApplicationServer.Caching.DataCacheLockHandle@,System.String)">
<summary>Locks the key if the key is present and is not locked and returns the object corresponding to the key. For objects stored in regions.</summary>
<returns>Returns <see cref="T:System.Object"></see> matching the specified key parameter if the <see cref="T:System.Object"></see> is present and is not locked.An error “Object does not exist”, error code ERRCA0008 is thrown if the key does not exist. Create objects based on the referenced key to resolve this error.An error “Object in cache is already locked”, error code ERRCA0013 is thrown if the key is already locked and will be inaccessible until it is unlocked by the locking client.</returns>
<param name="region">The name of the region where the object resides.</param>
<param name="key">The unique value that is used to identify the object in the region.</param>
<param name="lockHandle">The <see cref="T:Microsoft.ApplicationServer.Caching.DataCacheLockHandle"></see> object required to unlock the object. The lockHandle output parameter is passed by reference.</param>
<param name="timeout">The amount of time that the object remains locked.</param>
</member>
<member name="M:Microsoft.ApplicationServer.Caching.DataCache.GetAndLock(System.String,System.TimeSpan,Microsoft.ApplicationServer.Caching.DataCacheLockHandle@,System.String,System.Boolean)">
<summary>Lock the key if key is present and it is not locked by any clients and returns the object corresponding to the key. For objects stored in regions.</summary>
<returns>Returns <see cref="T:System.Object"></see> matching the specified key parameter if the <see cref="T:System.Object"></see> is present and is not locked.An error “Object does not exist”, error code ERRCA0008 is thrown if the key does not exist. Create objects based on the referenced key to resolve this error.An error “Object in cache is already locked”, error code ERRCA0013 is thrown if the key is already locked and will be inaccessible until it is unlocked by the locking client.</returns>
<param name="region">The name of the region where the object resides.</param>
<param name="key">The unique value that is used to identify the object in the region.</param>
<param name="lockHandle">The <see cref="T:Microsoft.ApplicationServer.Caching.DataCacheLockHandle"></see> object required to unlock the object. The lockHandle output parameter is passed by reference.</param>
<param name="forceLock">If forceLock is true, key is locked irrespective of key-value pair presence in cache.</param>
<param name="timeout">The amount of time that the object remains locked.</param>
</member>
<member name="M:Microsoft.ApplicationServer.Caching.DataCache.GetCacheItem(System.String)">
<summary>Gets a <see cref="T:Microsoft.ApplicationServer.Caching.DataCacheItem"></see> object to retrieve all information associated with your cached object in the cluster.</summary>
<returns>A<see cref="T:Microsoft.ApplicationServer.Caching.DataCacheItem"></see> object that contains all information associated with your cached object. Null is returned if the key does not exist.</returns>
<param name="key">The unique value that is used to identify the object in the cache.</param>
</member>
<member name="M:Microsoft.ApplicationServer.Caching.DataCache.GetCacheItem(System.String,System.String)">
<summary>Gets a <see cref="T:Microsoft.ApplicationServer.Caching.DataCacheItem"></see> object to retrieve all information associated with your cached object in the cluster. For objects stored in regions.</summary>
<returns>A <see cref="T:Microsoft.ApplicationServer.Caching.DataCacheItem"></see> object that contains all information associated with your cached object. Null is returned if the key does not exist.</returns>
<param name="region">The name of the region where the object resides.</param>
<param name="key">The unique value that is used to identify the object in the region.</param>
</member>
<member name="M:Microsoft.ApplicationServer.Caching.DataCache.GetIfNewer(System.String,Microsoft.ApplicationServer.Caching.DataCacheItemVersion@)">
<summary>Gets an object from the cache, but only if a newer version of the object resides in the cache.</summary>
<returns>If the version in the cache differs from the version parameter, the corresponding cached object is returned. If the version in the cache is the same as the version parameter, is returned.</returns>
<param name="version">The version of the desired object, passed by reference. If this parameter is , an exception is thrown.</param>
<param name="key">The unique value that is used to identify the object in the cache. If this parameter is , an exception is thrown.</param>
</member>
<member name="M:Microsoft.ApplicationServer.Caching.DataCache.GetIfNewer(System.String,Microsoft.ApplicationServer.Caching.DataCacheItemVersion@,System.String)">
<summary>Gets an object from the specified region, but only if a newer version of the object resides in the region.</summary>
<returns>If the version in the region differs from the version parameter, the corresponding cached object is returned. If the version in the region is the same as the version parameter, is returned.</returns>
<param name="version">The version of the desired object, passed by reference. If this parameter is , an exception is thrown.</param>
<param name="region">The name of the region where the object resides.</param>
<param name="key">The unique value that is used to identify the object in the cache. If this parameter is , an exception is thrown.</param>
</member>
<member name="M:Microsoft.ApplicationServer.Caching.DataCache.GetObjectsByAllTags(System.Collections.Generic.IEnumerable{Microsoft.ApplicationServer.Caching.DataCacheTag},System.String)">
<summary>Gets an enumerable list of all cached objects in the specified region that have all the same tags in common.</summary>
<returns>An enumerable list of all cached objects in the specified region that have all the same tags in common.</returns>
<param name="region">The name of the region to search. Tags are not supported outside regions. Therefore, a region name is required.</param>
<param name="tags">A list of tags for which to search.</param>
</member>
<member name="M:Microsoft.ApplicationServer.Caching.DataCache.GetObjectsByAnyTag(System.Collections.Generic.IEnumerable{Microsoft.ApplicationServer.Caching.DataCacheTag},System.String)">
<summary>Gets an enumerable list of all cached objects in the specified region that have any of the same tags in common.</summary>
<returns>An enumerable list of all cached objects in the specified region that have any of the same tags in common. Null is returned if no objects in the specified region have any of the tags specified.</returns>
<param name="region">The name of the region to search. Tags are not supported outside regions. Therefore, a region name is required.</param>
<param name="tags">A list of tags for which to search.</param>
</member>
<member name="M:Microsoft.ApplicationServer.Caching.DataCache.GetObjectsByTag(Microsoft.ApplicationServer.Caching.DataCacheTag,System.String)">
<summary>Gets an enumerable list of all cached objects in the specified region that have the specified tag.</summary>
<returns>An enumerable list of all cached objects in the specified region that have the specified tag. Null is returned if no objects in the specified region have the tag specified.</returns>
<param name="region">The name of the region to search. Tags are not supported outside regions. Therefore, a region name is required.</param>
<param name="tag">The tag for which to search.</param>
</member>
<member name="M:Microsoft.ApplicationServer.Caching.DataCache.GetObjectsInRegion(System.String)">
<summary>Gets an enumerable list of all cached objects in the specified region.</summary>
<returns>An enumerable list of all cached objects in the specified region.</returns>
<param name="region">The name of the region for which to return a list of all resident objects.</param>
</member>
<member name="M:Microsoft.ApplicationServer.Caching.DataCache.GetSystemRegionName(System.String)">
<summary>Returns the name of the region for the specified key.</summary>
<returns>Returns the region name as a <see cref="T:System.String"></see>.</returns>
<param name="key">The key for which to find the associated region.</param>
</member>
<member name="M:Microsoft.ApplicationServer.Caching.DataCache.GetSystemRegions">
<summary>Used to determine the default regions for the cache.</summary>
<returns>Returns an enumerable list of default regions for the cache as an <see cref="T:System.Collections.Generic.IEnumerable`1"></see> object.</returns>
</member>
<member name="M:Microsoft.ApplicationServer.Caching.DataCache.Put(System.String,System.Object)">
<summary>Adds or replaces an object in the cache.</summary>
<returns>A <see cref="T:Microsoft.ApplicationServer.Caching.DataCacheItemVersion"></see> object that represents the version of the object saved to the cache under the key value.</returns>
<param name="key">The unique value that is used to identify the object in the cache.</param>
<param name="value">The object to add or replace.</param>
</member>
<member name="M:Microsoft.ApplicationServer.Caching.DataCache.Put(System.String,System.Object,Microsoft.ApplicationServer.Caching.DataCacheItemVersion)">
<summary>Adds or replaces an object in the cache if it is at the specified version.</summary>
<returns>A <see cref="T:Microsoft.ApplicationServer.Caching.DataCacheItemVersion"></see> object that represents the version of the object saved to the cache under the key value.</returns>
<param name="oldVersion">The <see cref="T:Microsoft.ApplicationServer.Caching.DataCacheItemVersion"></see> object that represents the version of the cached object that is to be replaced.</param>
<param name="key">The unique value that is used to identify the object in the cache.</param>
<param name="value">The object to add or replace.</param>
</member>
<member name="M:Microsoft.ApplicationServer.Caching.DataCache.Put(System.String,System.Object,System.Collections.Generic.IEnumerable{Microsoft.ApplicationServer.Caching.DataCacheTag})">
<summary>Adds or replaces an object in the cache. Associates tags with the cached object.</summary>
<returns>A <see cref="T:Microsoft.ApplicationServer.Caching.DataCacheItemVersion"></see> object that represents the version of the object saved to the cache under the key value.</returns>
<param name="key">The unique value that is used to identify the object in the cache.</param>
<param name="value">The object to add or replace.</param>
<param name="tags">A list of tags to associate with the object.</param>
</member>
<member name="M:Microsoft.ApplicationServer.Caching.DataCache.Put(System.String,System.Object,System.String)">
<summary>Adds or replaces an object in the specified region.</summary>
<returns>A <see cref="T:Microsoft.ApplicationServer.Caching.DataCacheItemVersion"></see> object that represents the version of the object saved to the cache under the key value.</returns>
<param name="region">The name of the region the object resides in.</param>
<param name="key">The unique value that is used to identify the object in the region.</param>
<param name="value">The object to add or replace.</param>
</member>
<member name="M:Microsoft.ApplicationServer.Caching.DataCache.Put(System.String,System.Object,System.TimeSpan)">
<summary>Adds or replaces an object in the cache. Specifies the timeout value of the cached object.</summary>
<returns>A <see cref="T:Microsoft.ApplicationServer.Caching.DataCacheItemVersion"></see> object that represents the version of the object saved to the cache under the key value.</returns>
<param name="key">The unique value that is used to identify the object in the cache.</param>
<param name="value">The object to add or replace.</param>
<param name="timeout">The amount of time that the object should reside in the cache before expiration.</param>
</member>
<member name="M:Microsoft.ApplicationServer.Caching.DataCache.Put(System.String,System.Object,Microsoft.ApplicationServer.Caching.DataCacheItemVersion,System.Collections.Generic.IEnumerable{Microsoft.ApplicationServer.Caching.DataCacheTag})">
<summary>Adds or replaces an object in the cache if it is at the specified version. Associates tags with the cached object.</summary>
<returns>A <see cref="T:Microsoft.ApplicationServer.Caching.DataCacheItemVersion"></see> object that represents the version of the object saved to the cache under the key value.</returns>
<param name="oldVersion">The <see cref="T:Microsoft.ApplicationServer.Caching.DataCacheItemVersion"></see> object that represents the version of the cached object that is to be replaced.</param>
<param name="key">The unique value that is used to identify the object in the cache.</param>
<param name="value">The object to add or replace.</param>
<param name="tags">A list of tags to associate with the object.</param>
</member>
<member name="M:Microsoft.ApplicationServer.Caching.DataCache.Put(System.String,System.Object,Microsoft.ApplicationServer.Caching.DataCacheItemVersion,System.String)">
<summary>Adds or replaces an object in the specified region if it is at the specified version.</summary>
<returns>A <see cref="T:Microsoft.ApplicationServer.Caching.DataCacheItemVersion"></see> object that represents the version of the object saved to the cache under the key value.</returns>
<param name="oldVersion">The <see cref="T:Microsoft.ApplicationServer.Caching.DataCacheItemVersion"></see> object that represents the version of the cached object that is to be replaced.</param>
<param name="region">The name of the region the object resides in.</param>
<param name="key">The unique value that is used to identify the object in the region.</param>
<param name="value">The object to add or replace.</param>
</member>
<member name="M:Microsoft.ApplicationServer.Caching.DataCache.Put(System.String,System.Object,Microsoft.ApplicationServer.Caching.DataCacheItemVersion,System.TimeSpan)">
<summary>Adds or replaces an object in the cache if it is at the specified version. Specifies the timeout value of the cached object.</summary>
<returns>A <see cref="T:Microsoft.ApplicationServer.Caching.DataCacheItemVersion"></see> object that represents the version of the object saved to the cache under the key value.</returns>
<param name="oldVersion">The <see cref="T:Microsoft.ApplicationServer.Caching.DataCacheItemVersion"></see> object that represents the version of the cached object that is to be replaced.</param>
<param name="key">The unique value that is used to identify the object in the region.</param>
<param name="value">The object to add or replace.</param>
<param name="timeout">The amount of time that the object should reside in the cache before expiration.</param>
</member>
<member name="M:Microsoft.ApplicationServer.Caching.DataCache.Put(System.String,System.Object,System.Collections.Generic.IEnumerable{Microsoft.ApplicationServer.Caching.DataCacheTag},System.String)">
<summary>Adds or replaces an object in the specified region. Associates tags with the cached object.</summary>
<returns>A <see cref="T:Microsoft.ApplicationServer.Caching.DataCacheItemVersion"></see> object that represents the version of the object saved to the cache under the key value.</returns>
<param name="region">The name of the region the object resides in.</param>
<param name="key">The unique value that is used to identify the object in the region.</param>
<param name="value">The object to add or replace.</param>
<param name="tags">A list of tags to associate with the object.</param>
</member>
<member name="M:Microsoft.ApplicationServer.Caching.DataCache.Put(System.String,System.Object,System.TimeSpan,System.Collections.Generic.IEnumerable{Microsoft.ApplicationServer.Caching.DataCacheTag})">
<summary>Adds or replaces an object in the cache. Specifies the timeout value and associates tags with the cached object.</summary>
<returns>A <see cref="T:Microsoft.ApplicationServer.Caching.DataCacheItemVersion"></see> object that represents the version of the object saved to the cache under the key value.</returns>
<param name="key">The unique value that is used to identify the object in the cache</param>
<param name="value">The object to add or replace.</param>
<param name="timeout">The amount of time that the object should reside in the cache before expiration.</param>
<param name="tags">A list of tags to associate with the object.</param>
</member>
<member name="M:Microsoft.ApplicationServer.Caching.DataCache.Put(System.String,System.Object,System.TimeSpan,System.String)">
<summary>Adds or replaces an object in the specified region. Specifies the timeout value of the cached object.</summary>
<returns>A <see cref="T:Microsoft.ApplicationServer.Caching.DataCacheItemVersion"></see> object that represents the version of the object saved to the cache under the key value.</returns>
<param name="region">The name of the region the object resides in.</param>
<param name="key">Adds or replaces an object in the specified region. Specifies the timeout value of the cached object.</param>
<param name="value">The object to add or replace.</param>
<param name="timeout">The amount of time that the object should reside in the cache before expiration.</param>
</member>
<member name="M:Microsoft.ApplicationServer.Caching.DataCache.Put(System.String,System.Object,Microsoft.ApplicationServer.Caching.DataCacheItemVersion,System.Collections.Generic.IEnumerable{Microsoft.ApplicationServer.Caching.DataCacheTag},System.String)">
<summary>Adds or replaces an object in the specified region if it is at the specified version. Associates tags with the cached object.</summary>
<returns>A <see cref="T:Microsoft.ApplicationServer.Caching.DataCacheItemVersion"></see> object that represents the version of the object saved to the cache under the key value.</returns>
<param name="oldVersion">The <see cref="T:Microsoft.ApplicationServer.Caching.DataCacheItemVersion"></see> object that represents the version of the cached object that is to be replaced.</param>
<param name="region">The name of the region the object resides in.</param>
<param name="key">The unique value that is used to identify the object in the region.</param>
<param name="value">The object to add or replace.</param>
<param name="tags">A list of tags to associate with the object.</param>
</member>
<member name="M:Microsoft.ApplicationServer.Caching.DataCache.Put(System.String,System.Object,Microsoft.ApplicationServer.Caching.DataCacheItemVersion,System.TimeSpan,System.Collections.Generic.IEnumerable{Microsoft.ApplicationServer.Caching.DataCacheTag})">
<summary>Adds or replaces an object in the cache if it is at the specified version. Specifies the timeout value and associates tags with the cached object.</summary>
<returns>A <see cref="T:Microsoft.ApplicationServer.Caching.DataCacheItemVersion"></see> object that represents the version of the object saved to the cache under the key value.</returns>
<param name="oldVersion">The <see cref="T:Microsoft.ApplicationServer.Caching.DataCacheItemVersion"></see> object that represents the version of the cached object that is to be replaced.</param>
<param name="key">The unique value that is used to identify the object in the cache.</param>
<param name="value">The object to add or replace.</param>
<param name="timeout">The amount of time that the object should reside in the cache before expiration.</param>
<param name="tags">A list of tags to associate with the object.</param>
</member>
<member name="M:Microsoft.ApplicationServer.Caching.DataCache.Put(System.String,System.Object,Microsoft.ApplicationServer.Caching.DataCacheItemVersion,System.TimeSpan,System.String)">
<summary>Adds or replaces an object in the specified region if it is at the specified version. Specifies the timeout value of the cached object.</summary>
<returns>A <see cref="T:Microsoft.ApplicationServer.Caching.DataCacheItemVersion"></see> object that represents the version of the object saved to the cache under the key value.</returns>
<param name="oldVersion">The <see cref="T:Microsoft.ApplicationServer.Caching.DataCacheItemVersion"></see> object that represents the version of the cached object that is to be replaced.</param>
<param name="region">The name of the region the object resides in.</param>
<param name="key">The unique value that is used to identify the object in the region.</param>
<param name="value">The object to add or replace.</param>
<param name="timeout">The amount of time that the object should reside in the cache before expiration.</param>
</member>
<member name="M:Microsoft.ApplicationServer.Caching.DataCache.Put(System.String,System.Object,System.TimeSpan,System.Collections.Generic.IEnumerable{Microsoft.ApplicationServer.Caching.DataCacheTag},System.String)">
<summary>Adds or replaces an object in the specified region. Specifies the timeout value and associates tags with the cached object.</summary>
<returns>A <see cref="T:Microsoft.ApplicationServer.Caching.DataCacheItemVersion"></see> object that represents the version of the object saved to the cache under the key value.</returns>
<param name="region">The name of the region the object resides in.</param>
<param name="key">The unique value that is used to identify the object in the region.</param>
<param name="value">The object to add or replace.</param>
<param name="timeout">The amount of time that the object should reside in the cache before expiration.</param>
<param name="tags">A list of tags to associate with the object.</param>
</member>
<member name="M:Microsoft.ApplicationServer.Caching.DataCache.Put(System.String,System.Object,Microsoft.ApplicationServer.Caching.DataCacheItemVersion,System.TimeSpan,System.Collections.Generic.IEnumerable{Microsoft.ApplicationServer.Caching.DataCacheTag},System.String)">
<summary>Adds or replaces an object in the specified region if it is at the specified version. Specifies the timeout value and associates tags with the cached object.</summary>
<returns>A <see cref="T:Microsoft.ApplicationServer.Caching.DataCacheItemVersion"></see> object that represents the version of the object saved to the cache under the key value.</returns>
<param name="oldVersion">The <see cref="T:Microsoft.ApplicationServer.Caching.DataCacheItemVersion"></see> object that represents the version of the cached object that is to be replaced.</param>
<param name="region">The name of the region the object resides in.</param>
<param name="key">The unique value that is used to identify the object in the region.</param>
<param name="value">The object to add or replace.</param>
<param name="timeout">The amount of time that the object should reside in the cache before expiration.</param>
<param name="tags">A list of tags to associate with the object.</param>
</member>
<member name="M:Microsoft.ApplicationServer.Caching.DataCache.PutAndUnlock(System.String,System.Object,Microsoft.ApplicationServer.Caching.DataCacheLockHandle)">
<summary>Replaces and unlocks an object in the cache.</summary>
<returns>A <see cref="T:Microsoft.ApplicationServer.Caching.DataCacheItemVersion"></see> object that represents the version of the cached object after it has been updated by this method. If the lockHandle parameter is not equal to the DataCacheLockHandle object obtained from the method that is used to lock the object, is returned and the object is not updated.</returns>
<param name="key">The unique value that is used to identify the object in the cache.</param>
<param name="lockHandle">The <see cref="T:Microsoft.ApplicationServer.Caching.DataCacheLockHandle"></see> object that was returned when the object was locked.</param>
<param name="value">The object to add or replace.</param>
</member>
<member name="M:Microsoft.ApplicationServer.Caching.DataCache.PutAndUnlock(System.String,System.Object,Microsoft.ApplicationServer.Caching.DataCacheLockHandle,System.Collections.Generic.IEnumerable{Microsoft.ApplicationServer.Caching.DataCacheTag})">
<summary>Replaces and unlocks an object in the cache. Associates tags with the cached object.</summary>
<returns>A <see cref="T:Microsoft.ApplicationServer.Caching.DataCacheItemVersion"></see> object that represents the version of the cached object after it has been updated by this method. If the lockHandle parameter is not equal to the DataCacheLockHandle object obtained from the method that is used to lock the object, is returned and the object is not updated.</returns>
<param name="key">The unique value that is used to identify the object in the cache.</param>
<param name="lockHandle">The <see cref="T:Microsoft.ApplicationServer.Caching.DataCacheLockHandle"></see> object that was returned when the object was locked.</param>
<param name="value">The object to add or replace.</param>
<param name="tags">A list of tags to associate with the object.</param>
</member>
<member name="M:Microsoft.ApplicationServer.Caching.DataCache.PutAndUnlock(System.String,System.Object,Microsoft.ApplicationServer.Caching.DataCacheLockHandle,System.String)">
<summary>Replaces and unlocks an object in the specified region.</summary>
<returns>A <see cref="T:Microsoft.ApplicationServer.Caching.DataCacheItemVersion"></see> object that represents the version of the cached object after it has been updated by this method. If the lockHandle parameter is not equal to the DataCacheLockHandle object obtained from the method that is used to lock the object, is returned and the object is not updated.</returns>
<param name="region">The name of the region the object resides in.</param>
<param name="key">The unique value that is used to identify the object in the region.</param>
<param name="lockHandle">The <see cref="T:Microsoft.ApplicationServer.Caching.DataCacheLockHandle"></see> object that was returned when the object was locked.</param>
<param name="value">The object to add or replace.</param>
</member>
<member name="M:Microsoft.ApplicationServer.Caching.DataCache.PutAndUnlock(System.String,System.Object,Microsoft.ApplicationServer.Caching.DataCacheLockHandle,System.TimeSpan)">
<summary>Replaces and unlocks an object in the cache. Specifies the timeout value of the cached object.</summary>
<returns>A <see cref="T:Microsoft.ApplicationServer.Caching.DataCacheItemVersion"></see> object that represents the version of the cached object after it has been updated by this method. If the lockHandle parameter is not equal to the DataCacheLockHandle object obtained from the method that is used to lock the object, is returned and the object is not updated.</returns>
<param name="key">The unique value that is used to identify the object in the cache.</param>
<param name="lockHandle">The <see cref="T:Microsoft.ApplicationServer.Caching.DataCacheLockHandle"></see> object that was returned when the object was locked.</param>
<param name="value">The object to add or replace.</param>
<param name="timeout">The amount of time that the object should reside in the cache before expiration.</param>
</member>
<member name="M:Microsoft.ApplicationServer.Caching.DataCache.PutAndUnlock(System.String,System.Object,Microsoft.ApplicationServer.Caching.DataCacheLockHandle,System.Collections.Generic.IEnumerable{Microsoft.ApplicationServer.Caching.DataCacheTag},System.String)">
<summary>Replaces and unlocks an object in the specified region. Associates tags with the cached object.</summary>
<returns>A <see cref="T:Microsoft.ApplicationServer.Caching.DataCacheItemVersion"></see> object that represents the version of the cached object after it has been updated by this method. If the lockHandle parameter is not equal to the DataCacheLockHandle object obtained from the method that is used to lock the object, is returned and the object is not updated.</returns>
<param name="region">The name of the region the object resides in.</param>
<param name="key">The unique value that is used to identify the object in the region.</param>
<param name="lockHandle">The <see cref="T:Microsoft.ApplicationServer.Caching.DataCacheLockHandle"></see> object that was returned when the object was locked.</param>
<param name="value">The object to add or replace.</param>
<param name="tags">A list of tags to associate with the object.</param>
</member>
<member name="M:Microsoft.ApplicationServer.Caching.DataCache.PutAndUnlock(System.String,System.Object,Microsoft.ApplicationServer.Caching.DataCacheLockHandle,System.TimeSpan,System.Collections.Generic.IEnumerable{Microsoft.ApplicationServer.Caching.DataCacheTag})">
<summary>Replaces and unlocks an object in the cache. Specifies the timeout value and associates tags with the cached object.</summary>
<returns>A <see cref="T:Microsoft.ApplicationServer.Caching.DataCacheItemVersion"></see> object that represents the version of the cached object after it has been updated by this method. If the lockHandle parameter is not equal to the DataCacheLockHandle object obtained from the method that is used to lock the object, is returned and the object is not updated.</returns>
<param name="key">The unique value that is used to identify the object in the cache.</param>
<param name="lockHandle">The <see cref="T:Microsoft.ApplicationServer.Caching.DataCacheLockHandle"></see> object that was returned when the object was locked.</param>
<param name="value">The object to add or replace.</param>
<param name="timeout">The amount of time that the object should reside in the cache before expiration.</param>
<param name="tags">A list of tags to associate with the object.</param>
</member>
<member name="M:Microsoft.ApplicationServer.Caching.DataCache.PutAndUnlock(System.String,System.Object,Microsoft.ApplicationServer.Caching.DataCacheLockHandle,System.TimeSpan,System.String)">
<summary>Replaces and unlocks an object in the specified region. Specifies the timeout value of the cached object.</summary>
<returns>A <see cref="T:Microsoft.ApplicationServer.Caching.DataCacheItemVersion"></see> object that represents the version of the cached object after it has been updated by this method. If the lockHandle parameter is not equal to the DataCacheLockHandle object obtained from the method that is used to lock the object, is returned and the object is not updated. The timeout value associated with the cached object overrides expiration settings specified in the named cache configuration. For more information, see Expiration and Eviction (Velocity).</returns>
<param name="region">The name of the region the object resides in.</param>
<param name="key">The unique value that is used to identify the object in the region.</param>
<param name="lockHandle">The <see cref="T:Microsoft.ApplicationServer.Caching.DataCacheLockHandle"></see> object that was returned when the object was locked.</param>
<param name="value">The object to add or replace.</param>
<param name="timeout">The amount of time that the object should reside in the cache before expiration.</param>
</member>
<member name="M:Microsoft.ApplicationServer.Caching.DataCache.PutAndUnlock(System.String,System.Object,Microsoft.ApplicationServer.Caching.DataCacheLockHandle,System.TimeSpan,System.Collections.Generic.IEnumerable{Microsoft.ApplicationServer.Caching.DataCacheTag},System.String)">
<summary>Replaces and unlocks an object in the specified region. Specifies the timeout value and associates tags with the cached object.</summary>
<returns>A <see cref="T:Microsoft.ApplicationServer.Caching.DataCacheItemVersion"></see> object that represents the version of the cached object after it has been updated by this method. If the lockHandle parameter is not equal to the DataCacheLockHandle object obtained from the method that is used to lock the object, is returned and the object is not updated.</returns>
<param name="region">The name of the region the object resides in.</param>
<param name="key">The unique value that is used to identify the object in the region.</param>
<param name="lockHandle">The <see cref="T:Microsoft.ApplicationServer.Caching.DataCacheLockHandle"></see> object that was returned when the object was locked.</param>
<param name="value">The object to add or replace.</param>
<param name="timeout">The amount of time that the object should reside in the cache before expiration.</param>
<param name="tags">A list of tags to associate with the object.</param>
</member>
<member name="M:Microsoft.ApplicationServer.Caching.DataCache.Remove(System.String)">
<summary>Removes an object from the cache.</summary>
<returns>Returns true if the object identified by the key is removed. Returns false if the key was not found.</returns>
<param name="key">The unique value that is used to identify the object in the region.</param>
</member>
<member name="M:Microsoft.ApplicationServer.Caching.DataCache.Remove(System.String,Microsoft.ApplicationServer.Caching.DataCacheItemVersion)">
<summary>Removes an object from the cache if it is at the specified version.</summary>
<returns>Returns true if the object is removed. Returns false if an object with the specified key and version was not found.</returns>
<param name="version">The <see cref="T:Microsoft.ApplicationServer.Caching.DataCacheItemVersion"></see> object that represents the version of the cached object that is to be removed.</param>
<param name="key">The unique value that is used to identify the object in the region.</param>
</member>
<member name="M:Microsoft.ApplicationServer.Caching.DataCache.Remove(System.String,Microsoft.ApplicationServer.Caching.DataCacheLockHandle)">
<summary>Removes an object from the cache.</summary>
<returns>Returns <see cref="T:System.Boolean"></see>.</returns>
<param name="key">The unique value that is used to identify the object in the cache.</param>
</member>
<member name="M:Microsoft.ApplicationServer.Caching.DataCache.Remove(System.String,System.String)">
<summary>Removes an object from the specified region.</summary>
<returns>Returns <see cref="T:System.Boolean"></see>.</returns>
<param name="region">The name of the region the object resides in.</param>
<param name="key">The unique value that is used to identify the object in the region.</param>
</member>
<member name="M:Microsoft.ApplicationServer.Caching.DataCache.Remove(System.String,Microsoft.ApplicationServer.Caching.DataCacheItemVersion,System.String)">
<summary>Removes an object from the specified region if it is at the specified version.</summary>
<returns>Returns true if the object is removed. Returns false if an object with the specified key and version was not found in the region.</returns>
<param name="version">The <see cref="T:Microsoft.ApplicationServer.Caching.DataCacheItemVersion"></see> object that represents the version of the cached object that is to be removed.</param>
<param name="region">The name of the region the object resides in.</param>
<param name="key">The unique value that is used to identify the object in the region.</param>
</member>
<member name="M:Microsoft.ApplicationServer.Caching.DataCache.Remove(System.String,Microsoft.ApplicationServer.Caching.DataCacheLockHandle,System.String)">
<summary>Removes an object from the specified region.</summary>
<returns>Returns <see cref="T:System.Boolean"></see>.</returns>
<param name="region">The name of the region the object resides in.</param>
<param name="key">The unique value that is used to identify the object in the region.</param>
</member>
<member name="M:Microsoft.ApplicationServer.Caching.DataCache.RemoveCallback(Microsoft.ApplicationServer.Caching.DataCacheNotificationDescriptor)">
<summary>Removes a cache notification callback.</summary>
<param name="nd">The <see cref="T:Microsoft.ApplicationServer.Caching.DataCacheNotificationDescriptor"></see> object that identifies the callback that should be removed.</param>
</member>
<member name="M:Microsoft.ApplicationServer.Caching.DataCache.RemoveRegion(System.String)">
<summary>Deletes a region. All cached objects inside the region are also removed.</summary>
<returns>Returns true if the region is removed. Returns false if the region does not exist.</returns>
<param name="region">The name of the region.</param>
</member>
<member name="M:Microsoft.ApplicationServer.Caching.DataCache.ResetObjectTimeout(System.String,System.TimeSpan)">
<summary>Resets the object timeout value, defining how long objects reside in the cache before expiring. The value specified for the object overrides the default settings for the cache.</summary>
<param name="key">The unique value that is used to identify the object in the region.</param>
<param name="newTimeout">The amount of time that the object should reside in the cache before expiration.</param>
</member>
<member name="M:Microsoft.ApplicationServer.Caching.DataCache.ResetObjectTimeout(System.String,System.TimeSpan,System.String)">
<summary>Resets the object timeout value, defining how long objects reside in the region before expiring. The value specified for the object overrides the default settings for the cache.</summary>
<param name="region">The name of the region where the object resides.</param>
<param name="key">The unique value that is used to identify the object in the region.</param>
<param name="newTimeout">The amount of time that the object should reside in the cache before expiration.</param>
</member>
<member name="M:Microsoft.ApplicationServer.Caching.DataCache.Unlock(System.String,Microsoft.ApplicationServer.Caching.DataCacheLockHandle)">
<summary>Releases objects locked in the cache. This method supports pessimistic concurrency by making sure that the appropriate DataCacheLockHandle is used for unlocking the object.</summary>
<param name="key">The unique value that is used to identify the object in the region.</param>
<param name="lockHandle">The <see cref="T:Microsoft.ApplicationServer.Caching.DataCacheLockHandle"></see> object that was returned when the object was locked</param>
</member>
<member name="M:Microsoft.ApplicationServer.Caching.DataCache.Unlock(System.String,Microsoft.ApplicationServer.Caching.DataCacheLockHandle,System.String)">
<summary>Releases objects locked in the specified region. This method supports pessimistic concurrency by making sure that the appropriate DataCacheLockHandle is used for unlocking the object.</summary>
<param name="region">The name of the region where the object resides.</param>
<param name="key">The unique value that is used to identify the object in the region.</param>
<param name="lockHandle">The <see cref="T:Microsoft.ApplicationServer.Caching.DataCacheLockHandle"></see> object that was returned when the object was locked.</param>
</member>
<member name="M:Microsoft.ApplicationServer.Caching.DataCache.Unlock(System.String,Microsoft.ApplicationServer.Caching.DataCacheLockHandle,System.TimeSpan)">
<summary>Releases objects locked in the cache. This method supports pessimistic concurrency by making sure that the appropriate DataCacheLockHandle is used for unlocking the object. Specifies a new timeout value for the cached object.</summary>
<param name="key">The unique value that is used to identify the object in the region.</param>
<param name="lockHandle">The <see cref="T:Microsoft.ApplicationServer.Caching.DataCacheLockHandle"></see> object that was returned when the object was locked.</param>
<param name="timeout">The amount of time that the object should reside in the cache before expiration.</param>
</member>
<member name="M:Microsoft.ApplicationServer.Caching.DataCache.Unlock(System.String,Microsoft.ApplicationServer.Caching.DataCacheLockHandle,System.TimeSpan,System.String)">
<summary>Releases objects locked in the specified region. This method supports pessimistic concurrency by making sure that the appropriate DataCacheLockHandle is used for unlocking the object. Specifies a new timeout value for the cached object.</summary>
<param name="region">The name of the region where the object resides.</param>
<param name="key">The unique value that is used to identify the object in the region.</param>
<param name="lockHandle">The <see cref="T:Microsoft.ApplicationServer.Caching.DataCacheLockHandle"></see> object that was returned when the object was locked.</param>
<param name="timeout">The amount of time that the object should reside in the cache before expiration.</param>
</member>
<member name="P:Microsoft.ApplicationServer.Caching.DataCache.Item(System.String)">
<summary>Allows for the use of array notation to access cached objects.</summary>
<returns>A deserialized object that was saved to the cache cluster that uses the key.</returns>
<param name="key">The key that is used to save the cached object.</param>
</member>
<member name="T:Microsoft.ApplicationServer.Caching.DataCacheBulkNotificationCallback">
<summary>Specifies a callback which is called with a list of cache operations.</summary>
</member>
<member name="T:Microsoft.ApplicationServer.Caching.DataCacheFactory">
<summary>Provides methods to return <see cref="T:Microsoft.ApplicationServer.Caching.DataCache"></see> objects that are mapped to a named cache. This class also enables programmatic configuration of the cache client.</summary>
</member>
<member name="M:Microsoft.ApplicationServer.Caching.DataCacheFactory.#ctor">
<summary>Used for configuring a cache client based on the application configuration file.</summary>
</member>
<member name="M:Microsoft.ApplicationServer.Caching.DataCacheFactory.Dispose">
<summary>Closes the <see cref="T:Microsoft.ApplicationServer.Caching.DataCacheFactory"></see> object and releases all associated resources.</summary>
</member>
<member name="M:Microsoft.ApplicationServer.Caching.DataCacheFactory.GetCache(System.String)">
<summary>Returns the cache client, an instance of the <see cref="T:Microsoft.ApplicationServer.Caching.DataCache"></see> object.</summary>
<returns>The cache client, an instance of the DataCache object.</returns>
<param name="cacheName">The named cache to use for cache operations.</param>
</member>
<member name="M:Microsoft.ApplicationServer.Caching.DataCacheFactory.GetDefaultCache">
<summary>Returns the cache client corresponding to the default cache; an instance of the <see cref="T:Microsoft.ApplicationServer.Caching.DataCache"></see> object.</summary>
<returns>The cache client, an instance of the DataCache object.</returns>
</member>
<member name="T:Microsoft.ApplicationServer.Caching.DataCacheFailureNotificationCallback">
<summary>Specifies the parameters required for a method to be invoked by a failure notification when the cache client misses cache notifications.</summary>
</member>
<member name="T:Microsoft.ApplicationServer.Caching.DataCacheLocalCacheInvalidationPolicy">
<summary>Specifies the way locally cached objects should be invalidated.</summary>
</member>
<member name="F:Microsoft.ApplicationServer.Caching.DataCacheLocalCacheInvalidationPolicy.NotificationBased">
<summary>Specifies that objects will stay in local cache until they are automatically invalidated by a cache notification. </summary>
</member>
<member name="F:Microsoft.ApplicationServer.Caching.DataCacheLocalCacheInvalidationPolicy.TimeoutBased">
<summary>Specifies that objects will stay in local cache until their lifetime reaches the localCacheTimeout duration specified in the DataCacheFactory constructor. </summary>
</member>
<member name="T:Microsoft.ApplicationServer.Caching.DataCacheNotificationCallback">
<summary>Represents a callback method that is to be invoked by a cache notification when one or more cache operations take place.</summary>
</member>
<member name="T:Microsoft.ApplicationServer.Caching.DataCacheNotificationDescriptor">
<summary>Identifies a cache notification callback. This identifier is required to remove the corresponding cache notification callback.</summary>
</member>
<member name="M:Microsoft.ApplicationServer.Caching.DataCacheNotificationDescriptor.ToString">
<summary>Creates a copy of the <see cref="T:Microsoft.ApplicationServer.Caching.DataCacheNotificationDescriptor"></see> object.</summary>
<returns>A string value representing the <see cref="P:Microsoft.ApplicationServer.Caching.DataCacheNotificationDescriptor.CacheName"></see> and <see cref="P:Microsoft.ApplicationServer.Caching.DataCacheNotificationDescriptor.DelegateID"></see> property values.</returns>
</member>
<member name="P:Microsoft.ApplicationServer.Caching.DataCacheNotificationDescriptor.CacheName">
<summary>The name of the cache triggering the cache notification.</summary>
<returns>A string value represents the name of the cache triggering the cache notification.</returns>
</member>
<member name="P:Microsoft.ApplicationServer.Caching.DataCacheNotificationDescriptor.DelegateId">
<summary>Identifier for the <see cref="T:Microsoft.ApplicationServer.Caching.DataCacheNotificationDescriptor"></see> object. Used to distinguish between DataCacheNotificationDescriptor objects.</summary>
<returns>A <see cref="T:System.Int64"></see> value used to identify DataCacheNotificationDescriptor objects.</returns>
</member>
<member name="T:Microsoft.ApplicationServer.Caching.DataCacheServerEndpoint">
<summary>Used to specify an individual cache host when programmatically configuring the cache client.</summary>
</member>
<member name="M:Microsoft.ApplicationServer.Caching.DataCacheServerEndpoint.#ctor(System.String,System.Int32)">
<summary>Used to define a cache host in the cache cluster for programmatic configuration of the cache client.</summary>
<param name="cachePort">The cache port number of the cache host.</param>
<param name="hostName">The computer name of the cache server.</param>
</member>
<member name="P:Microsoft.ApplicationServer.Caching.DataCacheServerEndpoint.CachePort">
<summary>The cache port on the cache server.</summary>
<returns>A <see cref="T:System.Int32"></see> value that represents the cache port number on the cache server.</returns>
</member>
<member name="P:Microsoft.ApplicationServer.Caching.DataCacheServerEndpoint.HostName">
<summary>The computer name of the cache server.</summary>
<returns>A string representing the computer name of the cache server.</returns>
</member>
<member name="T:Microsoft.ApplicationServer.Caching.DataCacheSessionStoreProvider">
<summary>A session storage provider that enables Web applications to store session-state data to a distributed cache system.</summary>
</member>
<member name="M:Microsoft.ApplicationServer.Caching.DataCacheSessionStoreProvider.#ctor">
<summary>Initializes a new instance of the <see cref="T:Microsoft.ApplicationServer.Caching.DataCacheSessionStoreProvider"></see> class.</summary>
</member>
<member name="M:Microsoft.ApplicationServer.Caching.DataCacheSessionStoreProvider.CreateNewStoreData(System.Web.HttpContext,System.Int32)">
<summary>Creates a new data storage object for the current request.</summary>
<returns>A SessionStateStoreData object, used for storing session data in the distributed cache.</returns>
<param name="context">The HttpContext for the current request.</param>
<param name="timeout">The session state Timeout value for the new SessionStateStoreData object.</param>
</member>
<member name="M:Microsoft.ApplicationServer.Caching.DataCacheSessionStoreProvider.CreateUninitializedItem(System.Web.HttpContext,System.String,System.Int32)">
<summary>Adds a new session state to the distributed cache. </summary>
<param name="id">The session identifier for the current request.</param>
<param name="context">The HttpContext for the current request.</param>
<param name="timeout">The session Timeout for the current request.</param>
</member>
<member name="M:Microsoft.ApplicationServer.Caching.DataCacheSessionStoreProvider.Dispose">
<summary>Releases all resources used by the <see cref="T:Microsoft.ApplicationServer.Caching.DataCacheSessionStoreProvider"></see> class.</summary>
</member>
<member name="M:Microsoft.ApplicationServer.Caching.DataCacheSessionStoreProvider.EndRequest(System.Web.HttpContext)">
<summary>Called by the SessionStateModule class at the end of a request</summary>
<param name="context">The HttpContext for the current request.</param>
</member>
<member name="M:Microsoft.ApplicationServer.Caching.DataCacheSessionStoreProvider.GetItem(System.Web.HttpContext,System.String,System.Boolean@,System.TimeSpan@,System.Object@,System.Web.SessionState.SessionStateActions@)">
<summary>Returns read-only session-state data from the cache.</summary>
<returns>A SessionStateStoreData object populated with session values and information from the cache</returns>
<param name="lockAge">When this method returns, contains a TimeSpan object that is set to the period of time that an item in the cache has been locked.</param>
<param name="id">The session identifier for the current request.</param>
<param name="context">The HttpContext of the current request.</param>
<param name="actions">When this method returns, contains one of the SessionStateActions values. This indicates whether the current session is an uninitialized, cookieless session.</param>
<param name="locked">When this method returns, contains a Boolean value that is set to true if the requested session item is locked in the cache; otherwise, false.</param>
<param name="lockId">When this method returns, contains an object that is set to the lock identifier for the current request.</param>
</member>
<member name="M:Microsoft.ApplicationServer.Caching.DataCacheSessionStoreProvider.GetItemExclusive(System.Web.HttpContext,System.String,System.Boolean@,System.TimeSpan@,System.Object@,System.Web.SessionState.SessionStateActions@)">
<summary>Returns and locks the read-only session-state data from the cache.</summary>
<returns>A SessionStateStoreData object populated with session values and information from the cache.</returns>
<param name="lockAge">When this method returns, contains a TimeSpan object that is set to the period of time that an item in the cache has been locked.</param>
<param name="id">The session identifier for the current request.</param>
<param name="context">The HttpContext of the current request.</param>
<param name="actions">When this method returns, contains one of the SessionStateActions values. This indicates whether the current session is an uninitialized, cookieless session.</param>
<param name="locked">When this method returns, contains a Boolean value that is set to true if a lock in the cache is successfully obtained; otherwise, false.</param>
<param name="lockId">When this method returns, contains an object that is set to the lock identifier for the current request.</param>
</member>
<member name="M:Microsoft.ApplicationServer.Caching.DataCacheSessionStoreProvider.Initialize(System.String,System.Collections.Specialized.NameValueCollection)">
<summary>Initializes the distributed cache provider.</summary>
<param name="name">The name of the application.</param>
<param name="config">The configuration details specified in the application configuration file for cacheName and regionName.</param>
</member>
<member name="M:Microsoft.ApplicationServer.Caching.DataCacheSessionStoreProvider.ReleaseItemExclusive(System.Web.HttpContext,System.String,System.Object)">
<summary>Releases a lock on the session data in the cache.</summary>
<param name="id">The session identifier of the current request.</param>
<param name="context">The HttpContext of the current request.</param>
<param name="lockId">The lock identifier of the current request.</param>
</member>
<member name="M:Microsoft.ApplicationServer.Caching.DataCacheSessionStoreProvider.RemoveItem(System.Web.HttpContext,System.String,System.Object,System.Web.SessionState.SessionStateStoreData)">
<summary>Deletes session data from the cache.</summary>
<param name="id">The session identifier of the current request.</param>
<param name="context">The HttpContext of the current request.</param>
<param name="item">The SessionStateStoreData that represents the item to delete from the cache.</param>
<param name="lockId">The lock identifier of the current request.</param>
</member>
<member name="M:Microsoft.ApplicationServer.Caching.DataCacheSessionStoreProvider.ResetItemTimeout(System.Web.HttpContext,System.String)">
<param name="id">The session identifier of the current request.</param>
<param name="context">Updates the expiration date and time of session data in the cache.</param>
</member>
<member name="M:Microsoft.ApplicationServer.Caching.DataCacheSessionStoreProvider.SetAndReleaseItemExclusive(System.Web.HttpContext,System.String,System.Web.SessionState.SessionStateStoreData,System.Object,System.Boolean)">
<summary>Updates the session item information in the cache with values from the current request and clears the lock on the session item.</summary>
<param name="id">The session identifier of the current request..</param>
<param name="context">The HttpContext of the current request.</param>
<param name="newItem">If true, identifies the session item as a new item if true; otherwise, identifies the session item as an existing item.</param>
<param name="item">The SessionStateStoreData object that contains the current session values to be stored.</param>
<param name="lockId">The lock identifier for the current request.</param>
</member>
<member name="M:Microsoft.ApplicationServer.Caching.DataCacheSessionStoreProvider.SetItemExpireCallback(System.Web.SessionState.SessionStateItemExpireCallback)">
<summary>Sets a reference to the SessionStateItemExpireCallback delegate for the Session_OnEnd event defined in the Global.asax file.</summary>
<returns>Cache does not support notification of the expiration; therefore this method always returns false.</returns>
<param name="expireCallback">The SessionStateItemExpireCallback delegate for the Session_OnEnd event defined in the Global.asax file.</param>
</member>
<member name="P:Microsoft.ApplicationServer.Caching.DataCacheSessionStoreProvider.ApplicationName">
<returns>Returns <see cref="T:System.String"></see>.</returns>
</member>
</members>
</doc>
Submit an article or tip