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

Метод IHttpServer::GetManagedType

  • Статья

Извлекает управляемый тип для определенного сайта и универсальный код ресурса (URI).

Синтаксис

virtual HRESULT GetManagedType(  
   IN DWORD dwSiteId,  
   IN PCWSTR pszVirtualPath,  
   __out PWSTR pszManagedType,  
   IN OUT DWORD* pcchManagedType  
) = 0;

Параметры

dwSiteId
[IN] Идентификатор сайта для универсального кода ресурса (URI) в pszVirtualPath.

pszVirtualPath
[IN] Указатель на строку, содержащую универсальный код ресурса (URI).

pszManagedType
[__out] Указатель на предварительно определенный буфер строки.

pcchManagedType
[IN] [OUT] Длина буфера pszManagedType в байтах.

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

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

Значение Описание:
S_OK Указывает, что операция прошла успешно.
E_INVALIDARG Указывает, что в одном из параметров было передано недопустимое значение (например, для одного из указателей задано значение NULL).
E_OUTOFMEMORY Указывает, что недостаточно доступной памяти для выполнения операции.
ERROR_INVALID_PARAMETER Указывает, что в одном из параметров было передано недопустимое значение.
ERROR_INSUFFICIENT_BUFFER Указывает, что для выполнения операции недостаточно места в буфере.

Комментарии

Метод GetManagedType извлекает type атрибут для обработчика запросов, который будет обрабатывать определенный виртуальный путь, указанный параметрами dwSiteId и pszVirtualPath . Затем метод возвращает эти сведения в буфер, указанный параметром pszManagedType .

Важно!

Вызывающий объект должен выделить буфер для pszManagedType. Если вызывающий объект передает значение NULL для этого параметра, метод вернет E_INVALIDARG.

Атрибут type обработчика запросов находится в <handlers> разделе файла ApplicationHost.config. Этот атрибут содержит список пространств имен платформа .NET Framework для обработчика запросов. Например, обработчик запросов TraceHandler-Integrated по умолчанию имеет type атрибут System.Web.Handlers.TraceHandler.

Метод IHttpServer::GetManagedType отличается от метода IScriptMapInfo::GetManagedType тем, что IHttpServer::GetManagedType метод может получить type атрибут для любого виртуального пути, тогда как IScriptMapInfo::GetManagedType метод получает только type атрибут для интерфейса IScriptMapInfo .

Пример

В следующем примере кода показано, как использовать GetManagedType метод для создания модуля HTTP, который получает управляемый тип для URI /default.aspx.

Модуль выполняет следующие действия.

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

  2. Извлекает длину, необходимую для получения управляемого типа для запроса.

  3. Выделяет буфер для управляемого типа.

  4. Извлекает управляемый тип.

  5. Возвращает результат веб-клиенту, а затем завершает работу.

#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 );

        // Create an HRESULT to receive return values from methods.
        HRESULT hr;

        // Retrieve the site ID.
        DWORD dwSiteId = pHttpContext->GetSite()->GetSiteId();

        // Create buffers to store the managed type.
        PWSTR pwszManagedType =
            (PWSTR) pHttpContext->AllocateRequestMemory( 1 );
        char* pszManagedType = NULL;
        DWORD cchManagedType = 0;

        // Test for an error.
        if (NULL != pwszManagedType)
        {
            // Retrieve the size of the managed type.
            hr = g_pHttpServer->GetManagedType(
                dwSiteId,L"/default.aspx",
                pwszManagedType,&cchManagedType);
            // Test for an error.
            if ((HRESULT_CODE(hr)==ERROR_INSUFFICIENT_BUFFER) && (cchManagedType>0))
            {
                // Allocate space for the managed type.
                pwszManagedType =
                    (PWSTR) pHttpContext->AllocateRequestMemory(
                    (cchManagedType*2)+1 );
                // Test for an error.
                if (NULL == pwszManagedType)
                {
                    // Set the error status.
                    hr = HRESULT_FROM_WIN32(ERROR_NOT_ENOUGH_MEMORY);
                    pProvider->SetErrorStatus( hr );
                }
                else
                {
                    // Retrieve the managed type.
                    hr = g_pHttpServer->GetManagedType(
                        dwSiteId,L"/default.aspx",
                        pwszManagedType,&cchManagedType);
                    // Test for an error.
                    if (SUCCEEDED(hr))
                    {
                        // 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);
                        // Allocate space for the managed type.
                        pszManagedType =
                            (char*) pHttpContext->AllocateRequestMemory(
                            (DWORD) wcslen(pwszManagedType)+1 );
                        // Test for an error.
                        if (NULL == pszManagedType)
                        {
                            // Set the error status.
                            hr = HRESULT_FROM_WIN32(ERROR_NOT_ENOUGH_MEMORY);
                            pProvider->SetErrorStatus( hr );
                        }
                        else
                        {
                            // Convert the WCHAR string to a CHAR string.
                            wcstombs(pszManagedType,
                                pwszManagedType,wcslen(pwszManagedType));
                            // Return the managed type to the client.
                            WriteResponseMessage(pHttpContext,"Managed type: ",
                                (cchManagedType>1) ? pszManagedType : "n/a");
                        }
                        // End additional processing.
                        return RQ_NOTIFICATION_FINISH_REQUEST;
                    }
                }
            }
        }

        // Return processing to the pipeline.
        return RQ_NOTIFICATION_FINISH_REQUEST;
    }

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 );

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

Модуль должен экспортировать функцию RegisterModule . Эту функцию можно экспортировать, создав файл определения модуля (DEF- файл) для проекта, или скомпилировать модуль с помощью /EXPORT:RegisterModule параметра . Дополнительные сведения см. в разделе Пошаговое руководство. Создание модуля 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
Метод IScriptMapInfo::GetManagedType