ICacheManager::get_RefreshInterval, put_RefreshInterval Property [CS02]
For the latest version of Commerce Server 2007 Help, see the Microsoft Web site.
The RefreshInterval property is a read/write number that specifies the approximate number of seconds between automatic cache refresh operations on a specified cache.
HRESULT ICacheManager::get_RefreshInterval(
BSTR bstrName,
long* RefreshInterval
);
HRESULT ICacheManager::put_RefreshInterval(
BSTR bstrName,
long RefreshInterval
);
Property RefreshInterval(
bstrName As String
) As Long
Parameters
bstrName
[C++][in] A BSTR that contains the name of a data cache for which the refresh interval is being provided or retrieved.
[Visual Basic]
[in] A String that contains the name of a data cache for which the refresh interval is being provided or retrieved.
RefreshInterval
[C++][in] When putting the property, a long that contains the new refresh interval value.[out,retval] When getting the property, a pointer to a long used to return the current refresh interval value.
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 refresh interval value of zero (0) means that the cache is never refreshed automatically.
The default refresh interval value is zero (0).
The value is a measurement of the number of seconds between automatic cache refresh operations.