Cache.Put Method (String, String, Object, Tag , TimeSpan)

[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]

Adds a new object to the cache, or replaces one if it already occurs in the cache. This overload allows you to save your object to a region, update tags associated with the object, and specify an object expiration that overrides the default settings for the cache.

Namespace: System.Data.Caching
Assembly: ClientLibrary (in clientlibrary.dll)

Syntax

'Declaration
Public Function Put ( _
    region As String, _
    key As String, _
    value As Object, _
    tags As Tag(), _
    timeOut As TimeSpan _
) As CacheItemVersion
'Usage
Dim instance As Cache
Dim region As String
Dim key As String
Dim value As Object
Dim tags As Tag()
Dim timeOut As TimeSpan
Dim returnValue As CacheItemVersion

returnValue = instance.Put(region, key, value, tags, timeOut)

public CacheItemVersion Put (
    string region,
    string key,
    Object value,
    Tag[] tags,
    TimeSpan timeOut
)

public:
CacheItemVersion^ Put (
    String^ region, 
    String^ key, 
    Object^ value, 
    array<Tag^>^ tags, 
    TimeSpan timeOut
)

public CacheItemVersion Put (
    String region, 
    String key, 
    Object value, 
    Tag[] tags, 
    TimeSpan timeOut
)

public function Put (
    region : String, 
    key : String, 
    value : Object, 
    tags : Tag[], 
    timeOut : TimeSpan
) : CacheItemVersion

Parameters

• region
  The name of the region. Use DefaultRegion if the object is not stored in a region.

• key
  The unique value that is used to identify the object in the cache. If this parameter is null, an exception is thrown.

• value
  The object saved to the cache cluster.

• tags
  An array of Tag objects to associate with the cached object inside the region. If the region name is not provided, all tags are ignored.

• timeOut
  The duration of time that the object resides in the cache before expiration.

Return Value

A CacheItemVersion object that represents the version of the cached object after it has been updated by this method.

Remarks

Tags may only be used to retrieve a cached object if that object is saved to a region. Until a region name is provided, tags are ignored.

The timeOut parameter allows you to specify an object expiration that overrides the default settings for the cache. For more information, see Expiration and Eviction (Velocity).

See Also

Reference

Cache Class
Cache Members
System.Data.Caching Namespace