Skip to content

ihttpcachespecificdata-getflushed-method.md

Latest commit

 

History

History
62 lines (44 loc) · 4.42 KB

ihttpcachespecificdata-getflushed-method.md

File metadata and controls

62 lines (44 loc) · 4.42 KB
title IHttpCacheSpecificData::GetFlushed Method
description Learn how the IHttpCacheSpecificData::GetFlushed method returns a value indicating whether the specific data has been flushed from the cache.
ms.date 10/07/2016
ms.assetid 4cce500d-c3e2-a52c-3a15-32887e29c3dd

IHttpCacheSpecificData::GetFlushed Method

Returns a value indicating whether the specific data has been flushed from the cache.

Syntax

virtual BOOL GetFlushed(  
   VOID  
) const = 0;

Parameters

This method takes no parameters.

Return Value

true if the data has been flushed from the cache; otherwise, false.

Thread Safety

Classes that implement the IHttpCacheSpecificData interface are thread safe for the GetFlushed and SetFlushed methods.

Remarks

The behavior of the GetFlushed method is implementation specific. You should use the following information as a guideline, but it may not be correct in all scenarios:

  • Classes that implement the IHttpCacheSpecificData interface initialize a private Boolean flag to false as an instance variable during the construction of a new pointer. The classes then get and set this flag on subsequent calls to the GetFlushed and SetFlushed methods, respectively.

  • Classes that implement the IHttpFileInfo interface usually return false on GetFlushed and perform an empty operation on SetFlushed, because local files are considered to be always cached.

Example

The following code example demonstrates how to create a global module that listens for GL_CACHE_OPERATION and GL_CACHE_CLEANUP events and then writes the flush information to the Event Viewer.

Caution

[!INCLUDEiisver] generates a large number of events in the Event Viewer. To avoid a log overflow error in a production environment, you should generally avoid writing cache information to the event log. For demonstration purposes, this code example writes an entry to the Event Viewer in debug mode only.

[!code-cppIHttpCacheSpecificData#3]

For more information on how to create and deploy a native DLL module, see Walkthrough: Creating a Request-Level HTTP Module By Using Native Code.

The above code writes a new event to the application log of the Event Viewer, where the Data box contains a string similar to the following.

IHttpCacheSpecificData::GetFlushed: false

You can optionally compile the code by using the __stdcall (/Gz) calling convention instead of explicitly declaring the calling convention for each function.

Requirements

Type Description
Client - IIS 7.0 on [!INCLUDEwinvista]
- IIS 7.5 on Windows 7
- IIS 8.0 on Windows 8
- IIS 10.0 on Windows 10
Server - IIS 7.0 on [!INCLUDEwinsrv2008]
- 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
- [!INCLUDEiisexp75], [!INCLUDEiisexp80], [!INCLUDEiisexp100]
Header Httpserv.h

See Also

IHttpCacheSpecificData Interface