Cache.Put Method (String, String, Object, CacheItemVersion, 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 and specify an object expiration that overrides the default settings for the cache. This method also supports optimistic concurrency by accepting version information as a parameter.

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

Syntax

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

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

public CacheItemVersion Put (
    string region,
    string key,
    Object value,
    CacheItemVersion oldVersion,
    TimeSpan timeOut
)

public:
CacheItemVersion^ Put (
    String^ region, 
    String^ key, 
    Object^ value, 
    CacheItemVersion^ oldVersion, 
    TimeSpan timeOut
)

public CacheItemVersion Put (
    String region, 
    String key, 
    Object value, 
    CacheItemVersion oldVersion, 
    TimeSpan timeOut
)

public function Put (
    region : String, 
    key : String, 
    value : Object, 
    oldVersion : CacheItemVersion, 
    timeOut : TimeSpan
) : CacheItemVersion

Parameters

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

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

• value
  The object saved to the cache cluster.

• oldVersion
  The CacheItemVersion object that represents the version of the cached object that is updated. If null, the cached object is updated regardless.

• 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. If the oldVersion parameter is non-null, and not equal to the version of the cached object before this method call, null is returned and the object is not updated.

Remarks

By passing the oldVersion parameter, this method can maintain concurrency. If another process updates the cached object before this method is called, this method does not update the cached object and returns null. For more information, see Concurrency Models (Velocity) and Concurrency Methods (Velocity).

See Also

Reference

Cache Class
Cache Members
System.Data.Caching Namespace