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] 응답 상태 연결된 Win32 오류를 수신하는 에 대한 포인터 HRESULT 입니다.

ppszModule
[OUT] 상태 설정하는 모듈의 이름을 받는 문자열에 대한 포인터입니다.

pdwNotification
[OUT] 오류 상태 설정된 동안 알림을 받는 에 대한 포인터 DWORD 입니다.

ppException
[OUT] 이 상태 연결된 INativeSectionException 인터페이스에 대한 포인터입니다.

반환 값

VOID.

설명

메서드는 GetStatus 상태 코드, 하위 상태 코드, 상태 텍스트 및 오류가 있는 경우 응답 상태 연결된 Win32 오류로 구성된 전체 HTTP 응답 상태 반환합니다.

예제

다음 코드 예제에서는 메서드를 사용하여 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 메서드