ICacheManager::get_CacheObjectProgId, put_CacheObjectProgId Property [CS02]
For the latest version of Commerce Server 2007 Help, see the Microsoft Web site.
The CacheObjectProgId property is a read/write String that contains the name of the object to be used internally to perform caching functions for this CacheManager object. It also determines the type of object returned by the GetCache method.
HRESULT ICacheManager::get_CacheObjectProgId(
BSTR bstrName,
BSTR* CacheObjectProgId
);
HRESULT ICacheManager::put_CacheObjectProgId(
BSTR bstrName,
BSTR CacheObjectProgId
);
Property CacheObjectProgId(
bstrName As String
) As String
Parameters
bstrName
[C++][in] A BSTR that contains the name of the cache object.
[Visual Basic]
A String that contains the name of the cache object.
CacheObjectProgId
[C++][in] When putting the property, a BSTR that contains the Programmatic Identifier (ProgID) of the cache object.[out,retval] When getting the property, a pointer to a BSTR used to return the ProgID of the cache object.
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
[C++] The CacheObjectProgId parameter contains valid data only if the property was accessed successfully.
By default, the CacheManager object will have Commerce.Dictionary set as the value for this property.