Metode IHttpServer::GetConfigObject

Mengambil objek konfigurasi untuk konteks saat ini.

Sintaks

virtual INativeConfigurationSystem* GetConfigObject(  
   VOID  
) const = 0;

Parameter

Metode ini tidak memerlukan parameter.

Tampilkan Nilai

Penunjuk ke antarmuka INativeConfigurationSystem .

Keterangan

Metode ini GetConfigObject mengambil objek konfigurasi yang dapat Anda gunakan untuk mengambil pengaturan konfigurasi dari file konfigurasi. Misalnya, metode INativeConfigurationSystem::GetConfigSection mengambil antarmuka INativeConfigurationElement , yang merupakan objek kontainer untuk bagian pengaturan konfigurasi untuk konteks saat ini. Objek kontainer ini berisi beberapa metode yang dapat Anda gunakan untuk mengambil atau mengubah pengaturan konfigurasi.

Contoh

Contoh kode berikut menunjukkan cara membuat modul HTTP yang menggunakan metode IHttpContext::GetMetadata untuk mengambil penunjuk ke antarmuka IMetadataInfo . Modul menyelesaikan langkah-langkah berikut:

Menggunakan metode IMetadataInfo::GetMetaPath untuk mengambil jalur konfigurasi untuk permintaan saat ini.
GetConfigObject Menggunakan metode untuk mengambil pointer ke INativeConfigurationSystem antarmuka.
Meneruskan jalur konfigurasi untuk permintaan saat ini ke INativeConfigurationSystem::GetConfigSection metode .
Mengambil INativeConfigurationElement antarmuka untuk pengaturan log untuk IIS.
Menggunakan metode INativeConfigurationElement::GetBooleanProperty untuk mengambil nilai yang menunjukkan apakah pengelogan diaktifkan untuk konteks permintaan saat ini.
Mengembalikan informasi ini ke klien Web lalu keluar.

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

Modul Anda harus mengekspor fungsi RegisterModule . Anda dapat mengekspor fungsi ini dengan membuat file definisi modul (.def) untuk proyek Anda, atau Anda dapat mengkompilasi modul dengan menggunakan sakelar /EXPORT:RegisterModule . Untuk informasi selengkapnya, lihat Panduan: Membuat Modul HTTP Request-Level Dengan Menggunakan Kode Asli.

Anda dapat secara opsional mengkompilasi kode dengan menggunakan __stdcall (/Gz) konvensi panggilan alih-alih secara eksplisit mendeklarasikan konvensi panggilan untuk setiap fungsi.

Persyaratan

Jenis	Deskripsi
Klien	- IIS 7.0 di Windows Vista - IIS 7.5 di Windows 7 - IIS 8.0 di Windows 8 - IIS 10.0 pada Windows 10
Server	- IIS 7.0 di Windows Server 2008 - IIS 7.5 di Windows Server 2008 R2 - IIS 8.0 di Windows Server 2012 - IIS 8.5 di Windows Server 2012 R2 - IIS 10.0 di Windows Server 2016
Produk	- 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

Lihat juga

Antarmuka IHttpServer

Saran dan Komentar

Apakah halaman ini membantu?

Last updated on 2023-07-19