IHttpResponse：：GetStatus 方法

项目
07/19/2023

检索响应的 HTTP 状态。

语法

virtual VOID GetStatus(  
   OUT USHORT * pStatusCode,  
   OUT USHORT * pSubStatus = NULL,  
   OUT PCSTR * ppszReason = NULL,  
   OUT USHORT * pcchReason = NULL,  
   OUT HRESULT * phrErrorToReport = NULL,  
   OUT PCWSTR * ppszModule = NULL,  
   OUT DWORD * pdwNotification = NULL,  
   OUT INativeSectionException ** ppException = NULL  
) = 0;

parameters

pStatusCode
[OUT]指向接收响应的 HTTP 状态代码的无符号短整数的指针。

pSubStatus
[OUT]指向接收响应的 HTTP 子状态代码的无符号短整数的指针。

ppszReason
[OUT]指向接收响应的 HTTP 状态文本的字符串的指针。

pcchReason
[OUT]指向无符号短整数的指针，该整数接收响应状态字符串的长度（以字符为单位）。

phrErrorToReport
[OUT]指向 HRESULT 的指针，该指针接收与响应状态关联的 Win32 错误。

ppszModule
[OUT]指向接收设置状态的模块名称的字符串的指针。

pdwNotification
[OUT]指向 DWORD 的指针，该指针接收设置错误状态的通知。

ppException
[OUT]指向与此状态关联的 INativeSectionException 接口的指针。

返回值

VOID.

注解

方法 GetStatus 返回完整的 HTTP 响应状态，其中包括状态代码、子状态代码、状态文本以及与响应状态关联的 Win32 错误（如果存在错误）。

注意

响应状态字符串位于服务器拥有的缓冲区中。

示例

下面的代码示例演示如何使用 GetStatus 方法创建检索 HTTP 响应状态的 HTTP 模块。示例模块将 HTTP 响应状态的内容返回给客户端，并调用 IHttpResponse：：SetStatus 方法将响应状态设置为“200 正常”，以便客户端始终接收结果。

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

// Create the module class.
class MyHttpModule : public CHttpModule
{
public:
    REQUEST_NOTIFICATION_STATUS
    OnBeginRequest(
        IN IHttpContext * pHttpContext,
        IN IHttpEventProvider * pProvider
    )
    {
        UNREFERENCED_PARAMETER( pProvider );

        // Create buffers for the HTTP status fields.
        USHORT uStatusCode;
        USHORT uSubStatus;
        PCSTR  pszReason;
        USHORT chReason;
        PCWSTR pszModule;
        DWORD  pdwNotification;

        // Create an HRESULT to receive return values from methods.
        HRESULT hr;

        // Retrieve a pointer to the response.
        IHttpResponse * pHttpResponse = pHttpContext->GetResponse();

        // Test for an error.
        if (pHttpResponse != NULL)
        {
            // Retrieve the current HTTP status.
            pHttpResponse->GetStatus(
                &uStatusCode,&uSubStatus,&pszReason,&chReason,
                &hr,&pszModule,&pdwNotification,NULL);

            // Test for an error.
            if (NULL != pszReason)
            {
                // 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 buffer for the return message.
                char szBuffer[256];

                // Format the HTTP status.
                sprintf_s(szBuffer,255,"%u.%u %s",
                    uStatusCode,uSubStatus,pszReason);
                // Return the status to the client.
                WriteResponseMessage(pHttpContext,
                    "HTTP Status: ",szBuffer);

                // Set the HTTP status code.
                uStatusCode = 200;
                // Set the HTTP substatus code.
                uSubStatus = 0;
                // Set the HTTP status message.
                strcpy_s(szBuffer,255,"OK");
                
                // Set the HTTP status.
                hr = pHttpResponse->SetStatus(uStatusCode,
                    szBuffer,uSubStatus,S_OK);
                
                // Test for an error.
                if (FAILED(hr))
                {
                    // Set the error status.
                    pProvider->SetErrorStatus( hr );
                }

                // End additional processing.
                return RQ_NOTIFICATION_FINISH_REQUEST;
            }
        }

        // Return processing to the pipeline.
        return RQ_NOTIFICATION_CONTINUE;
    }

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_BEGIN_REQUEST,
        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

另请参阅

IHttpResponse 接口
 IHttpResponse：：SetStatus 方法

通过

IHttpResponse：：GetStatus 方法

语法

parameters

返回值

注解

示例

要求

另请参阅

反馈

其他资源