IHttpServer：：GetConfigObject 方法

项目
07/19/2023

检索当前上下文的配置对象。

语法

virtual INativeConfigurationSystem* GetConfigObject(  
   VOID  
) const = 0;

参数

此方法不采用参数。

返回值

指向 INativeConfigurationSystem 接口的指针。

备注

方法 GetConfigObject 检索可用于从配置文件检索配置设置的配置对象。例如， INativeConfigurationSystem：：GetConfigSection 方法检索 INativeConfigurationElement 接口，该接口是当前上下文配置设置部分的容器对象。此容器对象包含多个可用于检索或修改配置设置的方法。

示例

下面的代码示例演示如何创建使用 IHttpContext：：GetMetadata 方法检索指向 IMetadataInfo 接口的指针的 HTTP 模块。该模块完成以下步骤：

使用 IMetadataInfo：：GetMetaPath 方法检索当前请求的配置路径。
GetConfigObject使用方法检索指向接口的INativeConfigurationSystem指针。
将当前请求的配置路径传递给 INativeConfigurationSystem::GetConfigSection 方法。
INativeConfigurationElement检索 IIS 日志设置的接口。
使用 INativeConfigurationElement：：GetBooleanProperty 方法检索指示是否为当前请求上下文启用日志记录的值。
将此信息返回到 Web 客户端，然后退出。

#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;
        // Create a boolean variable for the configuration setting.
        BOOL fDoNotLog = FALSE;
        // Create pointers to configuration objects.
        INativeConfigurationSystem * pConfigSystem = NULL;
        INativeConfigurationElement * pConfigElement = NULL;

        // Retrieve a pointer to the IMetadataInfo interface.
        IMetadataInfo * pMetadataInfo = pHttpContext->GetMetadata();
        
        // Retrieve the configuration path.
        PCWSTR pwszConfigPath = pMetadataInfo->GetMetaPath();

        // Retrieve the configuration object.
        pConfigSystem = g_pHttpServer->GetConfigObject();

        // Test for an error.
        if (NULL != pConfigSystem)
        {        
            // Retrieve the HTTP logging configuration section.
            hr = pConfigSystem->GetConfigSection(
                L"system.webServer/httpLogging",
                pwszConfigPath,&pConfigElement,NULL,NULL);
        
            // Test for an error.
            if (SUCCEEDED(hr))
            {
                // Retrieve the log settings from the configuration section.
                hr = pConfigElement->GetBooleanProperty(
                    L"dontLog",&fDoNotLog,NULL);

                // 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 configuration path.
                    PSTR pszConfigPath =
                        (PSTR) pHttpContext->AllocateRequestMemory(
                        (DWORD) wcslen(pwszConfigPath) + 1 );

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

                    // Convert the WCHAR string to a CHAR string.
                    wcstombs(pszConfigPath,
                        pwszConfigPath,wcslen(pwszConfigPath));

                    // Return the configuration path.
                    WriteResponseMessage(pHttpContext,
                        "\nConfiguration path:\t",pszConfigPath);

                    // Return the configuration setting.
                    WriteResponseMessage(pHttpContext,"\nLogging enabled:\t",
                        (FALSE == fDoNotLog) ? "Yes" : "No");

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

    // 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 。有关详细信息，请参阅演练：使用本机代码创建Request-Level HTTP 模块。

可以选择使用调用约定编译代码， __stdcall (/Gz) 而不是为每个函数显式声明调用约定。

要求

类型	说明
客户端	- Windows Vista 上的 IIS 7.0 - Windows 7 上的 IIS 7.5 - Windows 8 上的 IIS 8.0 - Windows 10 上的 IIS 10.0
服务器	- Windows Server 2008 上的 IIS 7.0 - Windows Server 2008 R2 上的 IIS 7.5 - Windows Server 2012 上的 IIS 8.0 - Windows Server 2012 R2 上的 IIS 8.5 - Windows Server 2016 上的 IIS 10.0
产品	- 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
Header	Httpserv.h

另请参阅

IHttpServer 接口

通过

IHttpServer：：GetConfigObject 方法

语法

参数

返回值

备注

示例

要求

另请参阅

反馈

其他资源