Поделиться через

Метод IHttpServer::GetFileInfo

  • Статья

Возвращает интерфейс IHttpFileInfo для определенного пути к файлу.

Синтаксис

virtual HRESULT GetFileInfo(  
   IN PCWSTR pszPhysicalPath,  
   IN HANDLE hUserToken,  
   IN PSID pSid,  
   IN PCWSTR pszVrPath,  
   IN HANDLE hVrToken,  
   IN BOOL fCache,  
   OUT IHttpFileInfo** ppFileInfo,  
   IN IHttpTraceContext* pHttpTraceContext = NULL  
) = 0;

Параметры

pszPhysicalPath
[IN] Указатель на строку, содержащую физический путь к файлу.

hUserToken
[IN] Объект HANDLE , содержащий маркер для пользователя олицетворения; в противном случае — значение NULL.

pSid
[IN] Указатель на идентификатор безопасности (SID), содержащий идентификатор безопасности для пользователя олицетворения; в противном случае — NULL.

pszVrPath
[IN] Указатель на строку, содержащую виртуальный путь для регистрации для уведомлений об изменениях; в противном случае — NULL.

hVrToken
[IN] Объект , HANDLE содержащий токен олицетворения для регистрации для уведомлений об изменениях; в противном случае — значение NULL.

fCache
[IN] true значение , чтобы указать, что файл должен быть кэширован; в противном случае — false.

ppFileInfo
[OUT] Указатель на IHttpFileInfo интерфейс с разыменовкой.

pHttpTraceContext
[IN] Указатель на необязательный интерфейс IHttpTraceContext .

Возвращаемое значение

Объект HRESULT. Допустимые значения включают, но не ограничиваются, значения, приведенные в следующей таблице.

Значение Определение
S_OK Указывает, что операция прошла успешно.
E_FAIL Указывает, что вызов GetFileInfo был выполнен во время завершения узла модуля.

Комментарии

Метод IHttpServer::GetFileInfo создает IHttpFileInfo интерфейс для определенного пути. Этот метод отличается от метода IHttpContext::GetFileInfo , который возвращает IHttpFileInfo интерфейс для файла, обрабатываемого службами IIS в контексте запроса.

Параметры pszPhysicalPath и ppFileInfo необходимы для создания IHttpFileInfo интерфейса. Параметр pszPhysicalPath задает путь к файлу, а ppFileInfo параметр определяет указатель, который iis будет заполнять соответствующим IHttpFileInfo интерфейсом.

Параметры pszVrPath и hVrToken являются необязательными, и если они не используются, следует задать для них значение NULL. Эти параметры указывают, соответственно, виртуальный путь и маркер олицетворения, используемые при регистрации модуля для уведомлений об изменениях (например, если вы запрашиваете кэширование, задав fCache для параметра значение true).

Примечание

Другие параметры конфигурации могут препятствовать кэшированию файла службами IIS, даже если вы указываете true для fCache параметра .

Параметры hUserToken и pSid также являются необязательными, и если они не используются, следует задать для них значение NULL. Эти параметры указывают соответственно маркер и идентификатор безопасности для пользователя олицетворения. Оставшийся необязательный параметр , pHttpTraceContextуказывает IHttpTraceContext интерфейс для трассировки.

Пример

В следующем примере кода показано, как создать модуль HTTP, который выполняет следующие задачи:

  1. Регистрируется для уведомления RQ_BEGIN_REQUEST .

  2. Создает класс CHttpModule , содержащий метод OnBeginRequest . Когда клиент запрашивает файл, OnBeginRequest метод выполняет следующие задачи:

    1. Сопоставляет путь с относительным URL-адресом с помощью метода IHttpContext::MapPath .

    2. Создает IHttpFileInfo интерфейс для пути к файлу с помощью IHttpServer::GetFileInfo метода .

    3. Извлекает тег сущности для файла с помощью метода IHttpFileInfo::GetETag .

    4. Возвращает тег сущности клиенту с помощью метода IHttpResponse::WriteEntityChunks .

  3. Удаляет CHttpModule класс из памяти, а затем завершает работу.

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

// Create a pointer for the global server interface.
IHttpServer * g_pHttpServer = NULL;

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

        HRESULT hr;

        PWSTR wszUrl = L"/example/default.asp";
        WCHAR wszPhysicalPath[1024] = L"";
        DWORD cbPhysicalPath = 1024;

        pHttpContext->MapPath(wszUrl,wszPhysicalPath,&cbPhysicalPath);

        if (NULL != wszPhysicalPath)
        {
            IHttpFileInfo * pHttpFileInfo;
            hr = g_pHttpServer->GetFileInfo(wszPhysicalPath,
                NULL,NULL,wszUrl,NULL,TRUE,&pHttpFileInfo);
            if (NULL != pHttpFileInfo)
            {
                // Create a buffer for the Etag.
                USHORT cchETag;
                // Retrieve the Etag.
                PCSTR pszETag = pHttpFileInfo->GetETag(&cchETag);
                //Test for an error.
                if (NULL != pszETag)
                {
                    // 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);
                    // 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. (Defined in the Http.h file.)
        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 );

    // Store the pointer for the global server interface.
    g_pHttpServer = pGlobalInfo;

    // Set the request notifications and exit.
    return pModuleInfo->SetRequestNotifications(
        new MyHttpModuleFactory,
        RQ_BEGIN_REQUEST,
        0
    );
}

Дополнительные сведения о создании и развертывании собственного модуля DLL см. в разделе Пошаговое руководство. Создание модуля HTTP Request-Level с помощью машинного кода.

При необходимости можно скомпилировать код с помощью __stdcall (/Gz) соглашения о вызовах вместо явного объявления соглашения о вызовах для каждой функции.

Требования

Тип Описание
клиент — IIS 7.0 в Windows Vista
— IIS 7.5 в Windows 7
— IIS 8.0 в Windows 8
— IIS 10.0 в Windows 10
Сервер — IIS 7.0 в Windows Server 2008
— IIS 7.5 в Windows Server 2008 R2
— IIS 8.0 в Windows Server 2012
— IIS 8.5 в Windows Server 2012 R2
— IIS 10.0 в Windows Server 2016
Продукт — 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
Заголовок Httpserv.h

См. также:

Интерфейс IHttpServer
Метод IHttpContext::GetFileInfo