DataCache.Put Method (String, Object, TimeSpan, IEnumerable<DataCacheTag>)

 

Adds or replaces an object in the cache. Specifies the timeout value and associates tags with the cached object. This overload is not supported in Windows Azure Shared Caching.

Namespace:   Microsoft.ApplicationServer.Caching
Assembly:  Microsoft.ApplicationServer.Caching.Client (in Microsoft.ApplicationServer.Caching.Client.dll)

Syntax

public DataCacheItemVersion Put(
    string key,
    object value,
    TimeSpan timeout,
    IEnumerable<DataCacheTag> tags
)

public:
DataCacheItemVersion^ Put(
    String^ key,
    Object^ value,
    TimeSpan timeout,
    IEnumerable<DataCacheTag^>^ tags
)

member Put : 
        key:string *
        value:Object *
        timeout:TimeSpan *
        tags:IEnumerable<DataCacheTag> -> DataCacheItemVersion

Public Function Put (
    key As String,
    value As Object,
    timeout As TimeSpan,
    tags As IEnumerable(Of DataCacheTag)
) As DataCacheItemVersion

Parameters

• key
  Type: System.String

  The unique value that is used to identify the object in the cache. Key names must be less than 65 KB.

• value
  Type: System.Object

  The object to add or replace.

• timeout
  Type: System.TimeSpan

  The amount of time that the object should reside in the cache before expiration.

• tags
  Type: System.Collections.Generic.IEnumerable<DataCacheTag>

  A list of tags to associate with the object.

Return Value

Type: Microsoft.ApplicationServer.Caching.DataCacheItemVersion

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

Remarks

Tags may only be used to retrieve a cached object if that object is stored in a region. This overload does not store the object in a region.

The timeout value associated with the cached object overrides expiration settings specified in the named cache configuration.

See Also

Put Overload
DataCache Class
Microsoft.ApplicationServer.Caching Namespace

Return to top