IHttpResponse：：GetStatus 方法

擷取回應的 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;  

參數

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 OK」，因此用戶端一律會收到結果。

#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) 而不是明確宣告每個函式的呼叫慣例。

規格需求

另請參閱

IHttpResponse 介面
IHttpResponse：：SetStatus 方法