ISendResponseProvider：：GetFlags 方法

检索当前 HTTP 响应的标志。

语法

virtual DWORD GetFlags(  
   VOID  
) const = 0;  

参数

此方法不采用参数。

返回值

一个 DWORD 包含响应标志的 。

备注

可以使用 GetFlags 方法检索当前响应的响应标志。 这些标志提供对 IIS 7 的 HTTP 行为的附加控制。 Http.h 头文件中定义了以下标志。

名称	值	说明
HTTP_SEND_RESPONSE_FLAG_DISCONNECT	0x00000001	在发送响应后立即断开网络连接。
HTTP_SEND_RESPONSE_FLAG_MORE_DATA	0x00000002	在响应中发送其他数据。
HTTP_SEND_RESPONSE_FLAG_BUFFER_DATA	0x00000004	在发送响应之前缓冲响应。
HTTP_SEND_RESPONSE_FLAG_ENABLE_NAGLING	0x00000008	启用 Nagle 算法以优化 TCP 响应数据包。

示例

下面的代码示例演示如何使用 SetFlags 和 GetFlags 方法创建一个 HTTP 模块，该模块为当前响应设置标志。 然后，该示例检索修改后的标志，并将响应返回到 Web 客户端。

#define _WINSOCKAPI_
#include <windows.h>
#include <sal.h>
#include <httpserv.h>

// Create the module class.
class MyHttpModule : public CHttpModule
{
public:
    REQUEST_NOTIFICATION_STATUS
    OnSendResponse(
        IN IHttpContext * pHttpContext,
        IN ISendResponseProvider * pProvider
    )
    {
        // Set the flags.
        pProvider->SetFlags( pProvider->GetFlags() | 
            HTTP_SEND_RESPONSE_FLAG_DISCONNECT |
            HTTP_SEND_RESPONSE_FLAG_BUFFER_DATA );

        // Retrieve the flags.
        DWORD dwFlags = pProvider->GetFlags();

        // Clear the existing response.
        pHttpContext->GetResponse()->Clear();
        // Set the MIME type to plain text.
        pHttpContext->GetResponse()->SetHeader(
            HttpHeaderContentType,"text/plain",
            (USHORT)strlen("text/plain"),TRUE);

        // Create a string buffer for the return message.
        char szBuffer[256];
        sprintf_s(szBuffer,255,"0x%x\n",dwFlags);

        // Test for the disconnect flag.
        if (dwFlags & HTTP_SEND_RESPONSE_FLAG_DISCONNECT)
            strcat_s(szBuffer,255,
            "\nHTTP_SEND_RESPONSE_FLAG_DISCONNECT");

        // Test for the more data flag.
        if (dwFlags & HTTP_SEND_RESPONSE_FLAG_MORE_DATA)
            strcat_s(szBuffer,255,
            "\nHTTP_SEND_RESPONSE_FLAG_MORE_DATA");

        // Test for the buffer data flag.
        if (dwFlags & HTTP_SEND_RESPONSE_FLAG_BUFFER_DATA)
            strcat_s(szBuffer,255,
            "\nHTTP_SEND_RESPONSE_FLAG_BUFFER_DATA");

        // Return the message to the Web client.
        WriteResponseMessage(pHttpContext,"\nFlags: ",szBuffer);

        // End additional processing.
        return RQ_NOTIFICATION_FINISH_REQUEST;
    }

private:

    // Create a utility method that inserts a name/value pair into the response.
    HRESULT WriteResponseMessage(
        IHttpContext * pHttpContext,
        PCSTR pszName,
        PCSTR pszValue
    )
    {
        // Create an HRESULT to receive return values from methods.
        HRESULT hr;
        
        // Create a data chunk.
        HTTP_DATA_CHUNK dataChunk;
        // Set the chunk to a chunk in memory.
        dataChunk.DataChunkType = HttpDataChunkFromMemory;
        // Buffer for bytes written of data chunk.
        DWORD cbSent;

        // Set the chunk to the first buffer.
        dataChunk.FromMemory.pBuffer =
            (PVOID) pszName;
        // Set the chunk size to the first buffer size.
        dataChunk.FromMemory.BufferLength =
            (USHORT) strlen(pszName);
        // Insert the data chunk into the response.
        hr = pHttpContext->GetResponse()->WriteEntityChunks(
            &dataChunk,1,FALSE,TRUE,&cbSent);
        // Test for an error.
        if (FAILED(hr))
        {
            // Return the error status.
            return hr;
        }

        // Set the chunk to the second buffer.
        dataChunk.FromMemory.pBuffer =
            (PVOID) pszValue;
        // Set the chunk size to the second buffer size.
        dataChunk.FromMemory.BufferLength =
            (USHORT) strlen(pszValue);
        // Insert the data chunk into the response.
        hr = pHttpContext->GetResponse()->WriteEntityChunks(
            &dataChunk,1,FALSE,TRUE,&cbSent);
        // Test for an error.
        if (FAILED(hr))
        {
            // Return the error status.
            return hr;
        }

        // Return a success status.
        return S_OK;
    }
};

// Create the module's class factory.
class MyHttpModuleFactory : public IHttpModuleFactory
{
public:
    HRESULT
    GetHttpModule(
        OUT CHttpModule ** ppModule, 
        IN IModuleAllocator * pAllocator
    )
    {
        UNREFERENCED_PARAMETER( pAllocator );

        // Create a new instance.
        MyHttpModule * pModule = new MyHttpModule;

        // Test for an error.
        if (!pModule)
        {
            // Return an error if the factory cannot create the instance.
            return HRESULT_FROM_WIN32( ERROR_NOT_ENOUGH_MEMORY );
        }
        else
        {
            // Return a pointer to the module.
            *ppModule = pModule;
            pModule = NULL;
            // Return a success status.
            return S_OK;
        }            
    }

    void Terminate()
    {
        // Remove the class from memory.
        delete this;
    }
};

// Create the module's exported registration function.
HRESULT
__stdcall
RegisterModule(
    DWORD dwServerVersion,
    IHttpModuleRegistrationInfo * pModuleInfo,
    IHttpServer * pGlobalInfo
)
{
    UNREFERENCED_PARAMETER( dwServerVersion );
    UNREFERENCED_PARAMETER( pGlobalInfo );

    // Set the request notifications and exit.
    return pModuleInfo->SetRequestNotifications(
        new MyHttpModuleFactory,
        RQ_SEND_RESPONSE,
        0
    );
}

模块必须导出 RegisterModule 函数。 可以通过为项目创建模块定义 (.def) 文件导出此函数，也可以使用 开关编译模块 /EXPORT:RegisterModule 。 有关详细信息，请参阅 演练：使用本机代码创建Request-Level HTTP 模块。

可以选择使用调用约定编译代码， __stdcall (/Gz) 而不是为每个函数显式声明调用约定。

要求

类型	说明
客户端	- Windows Vista 上的 IIS 7.0 - Windows 7 上的 IIS 7.5 - Windows 8 上的 IIS 8.0 - Windows 10 上的 IIS 10.0
服务器	- Windows Server 2008 上的 IIS 7.0 - Windows Server 2008 R2 上的 IIS 7.5 - Windows Server 2012 上的 IIS 8.0 - Windows Server 2012 R2 上的 IIS 8.5 - Windows Server 2016 上的 IIS 10.0
产品	- 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

另请参阅

ISendResponseProvider 接口
ISendResponseProvider：：SetFlags 方法