ICacheProvider::SetCacheRecord Method

Sets the cache-specific data on the cache provider.

Syntax

virtual VOID SetCacheRecord(  
   IHttpCacheSpecificData* pCacheRecord  
) = 0;  

Parameters

pCacheRecord
A pointer to an IHttpCacheSpecificData value.

Remarks

The pCacheRecord parameter must not be NULL, because later internal calls to the GetCacheRecord method may cause an access violation.

Notes for Implementers

ICacheProvider implementers declare a private``IHttpCacheSpecificData pointer as member data. When constructors of these implementers are called, this member data is assigned to an IHttpCacheSpecificData pointer. Before calling SetCacheRecord, the caller is responsible for first calling IHttpCacheSpecificData::ReferenceCacheData on the IHttpCacheSpecificData pointer; SetCacheRecord implementers then assign the private variable to this IHttpCacheSpecificData pointer.

When SetCacheRecord is called, implementers should first check if the current private member pointer is non-NULL. If the private data is non-NULL, call IHttpCacheSpecificData::DereferenceCacheData first on this current data so that it can be released, but then always assign the private variable to the pCacheRecord parameter.

The following table is a sample of one-to-one interface mappings that must be returned from the GetCacheKey and GetCacheRecord methods from the same implementer of the ICacheProvider interface.

Notes for Callers

ICacheProvider implementers take ownership of the IHttpCacheSpecificData pointer. Before calling SetCacheRecord, first call IHttpCacheSpecificData::ReferenceCacheData on the pointer so that this pointer has one owner.

Requirements

See Also

ICacheProvider Interface