IHttpServer::ReadFragmentFromCache Method

Retrieves a specific fragment from the cache.

Syntax

virtual HRESULT ReadFragmentFromCache(  
   __in WCHAR* pszFragmentName,  
   BYTE* pvBuffer,  
   DWORD cbSize,  
   DWORD* pcbCopied  
) = 0;  

Parameters

pszFragmentName
[__in] A pointer to a WCHAR that specifies the fragment to retrieve from the cache.

pvBuffer
A pointer to a BYTE buffer that contains the cache fragment.

cbSize
A DWORD that contains the length, in bytes, of the buffer.

pcbCopied
A pointer to a DWORD that contains the number of bytes read from the cache.

Return Value

An HRESULT. Possible values include, but are not limited to, those in the following table.

Value	Description
S_OK	Indicates that the operation was successful.
ERROR_PATH_NOT_FOUND	Indicates that the fragment specified by the pszFragmentName parameter could not be found.

Remarks

Developers can use the AddFragmentToCache, ReadFragmentFromCache, and RemoveFragmentFromCache methods, respectively, to add HTTP_DATA_CHUNK structures to the fragment cache, or to retrieve and remove HTTP_DATA_CHUNK structures from the cache. These methods give developers a small degree of custom functionality to use the built-in IIS cache for storing and retrieving data fragments in the cache.

Note

Http.sys manages and owns the fragment cache. At any time, Http.sys may override or delete information that you directed to be stored. There is currently no way to lock information in the fragment cache as nonvolatile information.

Requirements

Type	Description
Client	- IIS 7.0 on Windows Vista - IIS 7.5 on Windows 7 - IIS 8.0 on Windows 8 - IIS 10.0 on Windows 10
Server	- IIS 7.0 on Windows Server 2008 - IIS 7.5 on Windows Server 2008 R2 - IIS 8.0 on Windows Server 2012 - IIS 8.5 on Windows Server 2012 R2 - IIS 10.0 on Windows Server 2016
Product	- IIS 7.0, IIS 7.5, IIS 8.0, IIS 8.5, IIS 10.0 - IIS Express 7.5, IIS Express 8.0, IIS Express 10.0
Header	Httpserv.h

See Also

IHttpServer Interface
IHttpServer::AddFragmentToCache Method
IHttpServer::RemoveFragmentFromCache Method