IHttpServer::GetWorkerProcessSettings メソッド

IWpfSettings インターフェイスを取得します。

構文

virtual HRESULT GetWorkerProcessSettings(  
   IWpfSettings** ppWorkerProcessSettings  
) = 0;  

パラメーター

ppWorkerProcessSettings
IWpfSettings インターフェイスへの逆参照されたポインター。

戻り値

HRESULT。 有効な値を次の表に示しますが、これ以外にもあります。

解説

メソッドを使用すると、開発者は GetWorkerProcessSettingsIWpfSettings インターフェイスを使用してワーカー プロセス フレームワークに関する構成情報を取得できます。

IWpfSettings では、ワーカー プロセス フレームワークに関する特定の情報を取得するために使用できるいくつかのメソッドが公開されています。 たとえば、 IWpfSettings::GetDwordProperty メソッドを使用すると、 IDLE_TIMEOUT または PERIODIC_RESTART_TIME の設定を取得できます。

例

次のコード例は、 メソッドを GetWorkerProcessSettings 使用して、サーバー上の共通言語ランタイム (CLR) のバージョンを取得する HTTP モジュールを作成する方法を示しています。 その後、モジュールはその情報を Web クライアントに返します。

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

// Create a pointer for the global server interface.
IHttpServer * g_pGlobalInfo = 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 pointer to an IWpfSettings class.
        IWpfSettings * pWpfSettings;

        // Retrieve the IWpfSettings class.
        hr = g_pGlobalInfo->GetWorkerProcessSettings(&pWpfSettings);

        // Test for an error.
        if (SUCCEEDED(hr))
        {
            PWSTR pwszSetting = NULL;
            DWORD cchSetting  = 1024;
            PSTR  pszSetting  = NULL;

            // Allocate space for the strings.
            pwszSetting = (PWSTR) pHttpContext->AllocateRequestMemory( cchSetting + 1 );
            pszSetting  = (PSTR)  pHttpContext->AllocateRequestMemory( cchSetting + 1 );

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

            // Retrieve the CLR version.
            hr = pWpfSettings->GetStringProperty(CLR_VERSION,pwszSetting,&cchSetting);

            // Test for an error.
            if (SUCCEEDED(hr))
            {
                // Convert the WCHAR string to a CHAR string.
                wcstombs(pszSetting,pwszSetting,cchSetting);
                
                // 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 CLR version to the client.
                WriteResponseMessage(pHttpContext,
                    "CLR Version: ",pszSetting);
                
                // 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_pGlobalInfo = 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) 明示的に宣言するのではなく、呼び出し規約を使用してコードをコンパイルできます。

要件

参照

IHttpServer インターフェイス
IWpfSettings インターフェイス