Cache.ResetObjectTimeout Method (String, TimeSpan)

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

Resets the object time-out, defining how long objects reside in the cache before expiring. The value specified for the object overrides the default settings for the cache.

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

Syntax

'Declaration
Public Function ResetObjectTimeout ( _
    key As String, _
    newTimeout As TimeSpan _
) As Boolean
'Usage
Dim instance As Cache
Dim key As String
Dim newTimeout As TimeSpan
Dim returnValue As Boolean

returnValue = instance.ResetObjectTimeout(key, newTimeout)

public bool ResetObjectTimeout (
    string key,
    TimeSpan newTimeout
)

public:
bool ResetObjectTimeout (
    String^ key, 
    TimeSpan newTimeout
)

public boolean ResetObjectTimeout (
    String key, 
    TimeSpan newTimeout
)

public function ResetObjectTimeout (
    key : String, 
    newTimeout : TimeSpan
) : boolean

Parameters

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

• newTimeout
  A non-zero time to live (TTL) value that is used to specify how many minutes the object resides in the cache before expiration.

Return Value

True, if successful; false, if unsuccessful.

Remarks

Unless explicitly specified at the time the object was added to the cache, the timeOut value specified in the named cache configuration is used. This method allows you to re-start the clock for object expiration. For more information, see Expiration and Eviction (Velocity).

See Also

Reference

Cache Class
Cache Members
System.Data.Caching Namespace