Skip to content

isendresponseprovider-getreadytologdata-method.md

Latest commit

 

History

History
57 lines (40 loc) · 3.91 KB

isendresponseprovider-getreadytologdata-method.md

File metadata and controls

57 lines (40 loc) · 3.91 KB
Raw
title ISendResponseProvider::GetReadyToLogData Method
description Describes the ISendResponseProvider::GetReadyToLogData method and details its syntax, return value, remarks, code example, and requirements.
ms.date 10/07/2016
ms.assetid c3ddf072-65c5-3260-de3f-653255dc7513

ISendResponseProvider::GetReadyToLogData Method

Retrieves a value that indicates whether IIS is ready to write information to the logs.

Syntax

virtual BOOL GetReadyToLogData(  
   VOID  
) const = 0;

Parameters

This method takes no parameters.

Return Value

true if IIS is ready to log information; otherwise, false.

Remarks

When writing HTTP modules that retrieve or modify the IIS log values, you should first call the GetReadyToLogData method to determine whether IIS is ready to log information. If the GetReadyToLogData method returns false, your module should not call the ISendResponseProvider::GetLogData method or it will return NULL.

Example

The following code example demonstrates how to create an HTTP module that uses the GetReadyToLogData method to determine whether IIS is ready log information. The module completes the following steps:

  1. Uses the GetLogData method to retrieve an HTTP_LOG_FIELDS_DATA structure.

  2. Uses this structure to retrieve the server name from the log information.

  3. Modifies the server port in the log entry.

  4. Uses the ISendResponseProvider::SetLogData method to submit the modified log information to IIS.

  5. Returns the server name to a Web client and then exits.

[!code-cppISendResponseProviderGetLogData#1]

Your module must export the RegisterModule function. You can export this function by creating a module definition (.def) file for your project, or you can compile the module by using the /EXPORT:RegisterModule switch. For more information, see Walkthrough: Creating a Request-Level HTTP Module By Using Native Code.

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

ISendResponseProvider Interface
ISendResponseProvider::GetLogData Method