IHttpFileInfo::GetETag 메서드

IHttpFileInfo 인터페이스에 대한 해당 파일의 엔터티 태그를 검색합니다.

구문

virtual PCSTR GetETag(  
   OUT USHORT* pcchETag = NULL  
) const = 0;  

매개 변수

pcchETag
[OUT] 반환된 문자열의 USHORT 길이(바이트)를 수신하는 버퍼에 대한 포인터입니다.

반환 값

엔터티 태그를 포함하는 문자열에 대한 포인터입니다.

설명

메서드는 GetETag 현재 인터페이스에서 참조하는 파일에 대한 엔터티 태그(ETag)를 IHttpFileInfo 검색합니다. 파일 비교에 엔터티 태그를 사용할 수 있습니다. 예를 들어 엔터티 태그를 사용하여 클라이언트에 의해 캐시된 파일이 서버의 버전과 다른지 여부를 확인할 수 있습니다.

메서드를 GetETag 호출하면 매개 변수에 pcchETag 반환된 엔터티 태그의 크기(바이트)가 포함됩니다.

예제

다음 코드 예제에서는 IHttpContext::GetFileInfo 메서드를 사용하여 현재 요청에 대한 인터페이스에 대한 포인터를 검색하는 HTTP 모듈을 IHttpFileInfo 만드는 방법을 보여 줍니다. 그런 다음, 메서드를 GetETag 호출하여 요청된 파일에 대한 엔터티 태그를 검색하고 이 정보를 웹 클라이언트에 표시합니다.

#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 );
        
        // Get a pointer to an IHttpFileInfo class.
        IHttpFileInfo * pHttpFileInfo = pHttpContext->GetFileInfo();

        // Test for an error.
        if (NULL != pHttpFileInfo)
        {
            // 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 Etag.
            USHORT cchETag;

            // Retrieve the Etag.
            PCSTR pszETag = pHttpFileInfo->GetETag(&cchETag);

            //Test for an error.
            if (NULL != pszETag)
            {
                // Return the Etag to the client.
                WriteResponseMessage(pHttpContext,
                    "ETag: ",pszETag);
            }
            
            // 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_SEND_RESPONSE,
        0
    );
}

모듈은 RegisterModule 함수를 내보내야 합니다. 프로젝트에 대한 모듈 정의(.def) 파일을 만들어 이 함수를 내보내거나 스위치를 사용하여 /EXPORT:RegisterModule 모듈을 컴파일할 수 있습니다. 자세한 내용은 연습: 네이티브 코드를 사용하여 Request-Level HTTP 모듈 만들기를 참조하세요.

필요에 따라 각 함수에 대한 호출 규칙을 명시적으로 선언하는 대신 호출 규칙을 사용하여 __stdcall (/Gz) 코드를 컴파일할 수 있습니다.

요구 사항

참고 항목

IHttpFileInfo 인터페이스