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

 

Adds an object to a region in the cache. This method provides the ability to specify when the object should be expired. 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 Add(
    string key,
    object value,
    TimeSpan timeout,
    string region
)

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

member Add : 
        key:string *
        value:Object *
        timeout:TimeSpan *
        region:string -> DataCacheItemVersion

Public Function Add (
    key As String,
    value As Object,
    timeout As TimeSpan,
    region As String
) As DataCacheItemVersion

Parameters

• key
  Type: System.String

  A unique value that is used to store and retrieve the object from the cache. Key names must be less than 65 KB.

• value
  Type: System.Object

  The object saved to the cache.

• timeout
  Type: System.TimeSpan

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

• region
  Type: System.String

  The name of the region to save the object.

Return Value

Type: Microsoft.ApplicationServer.Caching.DataCacheItemVersion

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

Remarks

If an item using the same key is already present in the cache, this call throws an exception of type DataCacheException with the ErrorCode set to KeyAlreadyExists. The timeout value associated with the cached object overrides expiration settings specified in the named cache configuration.

See Also

Add Overload
DataCache Class
Microsoft.ApplicationServer.Caching Namespace

Return to top