DataCache.Put Method (String, Object, TimeSpan, String)

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

Adds or replaces an object in the specified region. Specifies the timeout value of the cached object.

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

Syntax

'Declaration
Public Function Put ( _
    key As String, _
    value As Object, _
    timeout As TimeSpan, _
    region As String _
) As DataCacheItemVersion
'Usage
Dim instance As DataCache
Dim key As String
Dim value As Object
Dim timeout As TimeSpan
Dim region As String
Dim returnValue As DataCacheItemVersion

returnValue = instance.Put(key, value, timeout, region)

public DataCacheItemVersion Put (
    string key,
    Object value,
    TimeSpan timeout,
    string region
)

public:
DataCacheItemVersion^ Put (
    String^ key, 
    Object^ value, 
    TimeSpan timeout, 
    String^ region
)

public DataCacheItemVersion Put (
    String key, 
    Object value, 
    TimeSpan timeout, 
    String region
)

public function Put (
    key : String, 
    value : Object, 
    timeout : TimeSpan, 
    region : String
) : DataCacheItemVersion

Parameters

• key
  The unique value that is used to identify the object in the region.

• value
  The object to add or replace.

• timeout
  A non-zero value that is used to specify how many minutes the object should reside in the cache before expiration.

• region
  The name of the region the object resides in.

Return Value

A DataCacheItemVersion object that represents the version of the object saved to the cache under the key value.

Remarks

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).

For more information about using this method, see How to: Update an Object in Cache (Velocity).

See Also

Reference

DataCache Class
DataCache Members
Microsoft.Data.Caching Namespace