ICacheManager::get_CacheObjectProgId, put_CacheObjectProgId
.gif "Ee797350.c++_off(en-US,CS.10).gif")
.gif "Ee797350.vb_on(en-US,CS.10).gif")
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.
Definition
Get method:
HRESULT ICacheManager::get_CacheObjectProgId(BSTRbstrName,BSTR*CacheObjectProgId);
Put method:
HRESULT ICacheManager::put_CacheObjectProgId(BSTRbstrName,BSTRCacheObjectProgId);
Parameters
bstrName
[in] A BSTR that contains the name of the cache object.
CacheObjectProgId
[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 it completed successfully. See the Error Values section for more details.
Error Values
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.
Remarks
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.
For more information about memory ownership issues related to COM property and method parameters, see Managing COM Parameter Memory.