ICacheManager::get_RetryInterval, put_RetryInterval Property [C++]

Article
11/12/2009

The RetryInterval property is a read/write number that specifies the approximate number of seconds to wait before retrying to load the data cache after failing to load.

Definition

[C++]

Get method:

HRESULT ICacheManager::get_RetryInterval(BSTRbstrName,
 long*RetryInterval);

Put method:

HRESULT ICacheManager::put_RetryInterval(BSTRbstrName,
 longRetryInterval);

[Visual Basic]

Property RetryInterval(bstrName As String) As Long

Parameters

bstrName[C++]
[in] A BSTR that contains the name of a data cache for which the retry interval is being provided or retrieved.
bstrName[Visual Basic]
A String that contains the name of a data cache for which the retry interval is being provided or retrieved.
RetryInterval[C++]
[in] When putting the property, a long that contains the new retry interval value.
[out,retval] When getting the property, a pointer to a long used to return the current retry interval value.

[C++]

Return Values

These methods return an HRESULT indicating whether they completed successfully. See the Error Values section for more details.

Error Values

[C++] These methods return S_OK (0x00000000) to indicate success and standard COM HRESULT error values to indicate failure. For more information about standard COM errors, see Standard COM Errors. Additional information may be available using the global Err object, which can be accessed using the API function GetErrorInfo. In particular, the GetDescription method of the IErrorInfo interface may return a text description of the error.

[Visual Basic] This property sets the Number property of the global Err object to S_OK (&H00000000) to indicate success and to standard COM error values to indicate failure. For more information about standard COM errors, see Standard COM Errors. Additional information may be available using the global Err object. In particular, the Description property may contain a text description of the error.

Remarks

A retry interval value provides the number of seconds the CacheManager object should wait before retrying a failed cache refresh operation.

The default retry interval value is 60 (seconds).

The retry interval must be at least 1 (second).