IHttpResponse::SetHeader 메서드

지정된 HTTP 응답 헤더의 값을 설정하거나 추가합니다.

구문

virtual HRESULT SetHeader(  
   IN PCSTR pszHeaderName,  
   IN PCSTR pszHeaderValue,  
   IN USHORT cchHeaderValue,  
   IN BOOL fReplace  
) = 0;  
  
virtual HRESULT SetHeader(  
   IN HTTP_HEADER_ID ulHeaderIndex,  
   IN PCSTR pszHeaderValue,  
   IN USHORT cchHeaderValue,  
   IN BOOL fReplace  
) = 0;  

매개 변수

pszHeaderName
[IN] 설정할 HTTP 헤더의 이름을 포함하는 문자열에 대한 포인터입니다.

ulHeaderIndex
[IN] 설정할 HTTP 헤더의 ID입니다.

pszHeaderValue
[IN] 설정할 헤더의 값을 포함하는 문자열에 대한 포인터입니다.

cchHeaderValue
[IN] \0 문자를 포함하지 않는 헤더 값의 길이(문자)입니다.

fReplace
[IN] 기존 헤더를 덮어쓸지 여부를 지정합니다.

반환 값

HRESULT입니다. 가능한 값에는 다음 표에 있는 값이 포함되지만, 이에 국한되는 것은 아닙니다.

설명

메서드는 SetHeader 현재 응답에 대한 HTTP 헤더 값을 설정합니다. 메서드의 오버로드된 버전이 두 개 있습니다 SetHeader . 첫 번째 를 사용하면 매개 변수에 포함된 문자열을 사용하여 헤더를 pszHeaderName 지정할 수 있습니다. 다른 오버로드는 매개 변수에 포함된 ulHeaderIndex 부호 없는 긴 정수를 사용합니다.

매개 변수에 지정된 pszHeaderName 헤더 이름은 사용자 지정 헤더 또는 RFC(Request for Comments) 1945, "Hypertext Transfer Protocol -- HTTP/1.0" 또는 RFC 2616, "Hypertext Transfer Protocol -- HTTP/1.1"에 정의된 헤더일 수 있습니다.

매개 변수는 ulHeaderIndex 열거형에 나열된 HTTP 헤더의 ID를 HTTP_HEADER_ID 지정합니다.

매개 변수가 true인 fReplace 경우 지정된 헤더 값은 헤더가 있는 경우 기존 헤더 값을 대체합니다. 이 이false면 fReplace 지정된 헤더 값을 기존 헤더에 추가하고 헤더 자체에서 쉼표로 구분해야 합니다.

예제

다음 코드 예제에서는 메서드의 SetHeader 오버로드를 모두 사용하여 HTTP Content-Type 및 Server 헤더를 사용자 지정 값으로 바꾸고 HTTP Refresh 헤더를 특정 시간(초)으로 설정하는 방법을 보여 줍니다.

#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
    )
    {
        UNREFERENCED_PARAMETER( pProvider );

        // Create an HRESULT to receive return values from methods.
        HRESULT hr;
        
        // Set the "Refresh" header name.
        char szRefreshName[] = "Refresh";
        // Set the "Refresh" header value.
        char szRefreshValue[] = "30";
        // Set the "Content-Type" header value.
        char szContentType[] = "text/plain";
        // Set the "Server" header value.
        char szServerValue[] = "MyServer/7.0";

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

        // Test for an error.
        if (pHttpResponse != NULL)
        {

            // Set the "Refresh" header.
            hr = pHttpResponse->SetHeader(
                szRefreshName,szRefreshValue,
                (USHORT)strlen(szRefreshValue),FALSE);

            // Test for an error.
            if (FAILED(hr))
            {
                // Set the error status.
                pProvider->SetErrorStatus( hr );
                // End additional processing.
                return RQ_NOTIFICATION_FINISH_REQUEST;
            }

            // Set the "Content-Type" header.
            hr = pHttpResponse->SetHeader(
                HttpHeaderContentType,szContentType,
                (USHORT)strlen(szContentType),TRUE);

            // Test for an error.
            if (FAILED(hr))
            {
                // Set the error status.
                pProvider->SetErrorStatus( hr );
                // End additional processing.
                return RQ_NOTIFICATION_FINISH_REQUEST;
            }

            // Set the "Server" header.
            hr = pHttpResponse->SetHeader(
                "Server",szServerValue,
                (USHORT)strlen(szServerValue),TRUE);

            // 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;
    }
};

// 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) 코드를 컴파일할 수 있습니다.

요구 사항

참고 항목

IHttpResponse 인터페이스
IHttpResponse::D eleteHeader 메서드
IHttpResponse::GetHeader 메서드