IScriptMapInfo::GetAllowPathInfoForScriptMappings メソッド

[アーティクル]
07/19/2023

スクリプトマップハンドラーに属性がに設定されているかどうかを示す値をallowPathInfotrue取得します。

構文

virtual BOOL GetAllowPathInfoForScriptMappings(
   VOID
) const = 0;

パラメーター

このメソッドは、パラメーターを受け取りません。

戻り値

true スクリプトマップの allowPathInfo 属性がに true設定されている場合は。それ以外の場合 falseは。

解説

開発者は、メソッドを GetAllowPathInfoForScriptMappings 使用して、要求を処理するときに PathInfo データを許可するように HTTP ハンドラーが構成されているかどうかを指定する値を取得できます。 PathInfo は、Uniform Resource Identifier (URI) 内のファイル名と拡張子に従う可能性がある追加のパス情報を参照します。たとえば、URI を要求した場合、その URI http://localhost/test.dll/myinfoの PathInfo 部分は /myinfo です。

PathInfo 情報の使用を許可する HTTP ハンドラーを構成するには、ApplicationHost.config ファイル内の HTTP ハンドラーの属性をにtrue設定allowPathInfoします。たとえば、ApplicationHost.config ファイル内の Internet Server API (ISAPI) DLL の構成セクションは、次の例のようになります。

<add name="ISAPI-dll"
    path="*.dll"
    verb="*"
    modules="IsapiModule"
    resourceType="File"
    requireAccess="Execute"
    allowPathInfo="true" />

この例では、ISAPI DLL の PathInfo データを有効にします。同様に、属性を allowPathInfo に false 設定して PathInfo データを無効にします。

例

次のコード例では、メソッドを使用 GetAllowPathInfoForScriptMappings して、IScriptMapInfo インターフェイスへのポインターを取得する HTTP モジュールを作成する方法を示します。次に、メソッドを GetAllowPathInfoForScriptMappings 使用して、スクリプトマップに 対して PathInfo データが有効かどうかを示す値を取得します。モジュールは結果を Web クライアントに返し、終了します。

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

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

        // Retrieve the IScriptMapInfo interface.
        IScriptMapInfo * pScriptMapInfo = pHttpContext->GetScriptMap();

        // Test for an error.
        if (NULL != pScriptMapInfo)
        {
            // Retrieve the path info status.
            BOOL fPathInfo = pScriptMapInfo->GetAllowPathInfoForScriptMappings();
            // Return the path info status to the client.
            WriteResponseMessage(pHttpContext,"PathInfo Allowed: ",
                (TRUE == fPathInfo) ? "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 );
    UNREFERENCED_PARAMETER( pGlobalInfo );

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

モジュールで RegisterModule 関数をエクスポートする必要があります。この関数をエクスポートするには、プロジェクトのモジュール定義 (.def) ファイルを作成するか、スイッチを使用してモジュールを /EXPORT:RegisterModule コンパイルします。詳細については、「チュートリアル: ネイティブコードを使用したRequest-Level HTTP モジュールの作成」を参照してください。

必要に応じて、各関数の呼び出し規約を __stdcall (/Gz) 明示的に宣言するのではなく、呼び出し規約を使用してコードをコンパイルできます。

要件

Type	説明
Client	- 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

次の方法で共有

IScriptMapInfo::GetAllowPathInfoForScriptMappings メソッド

構文

パラメーター

戻り値

解説

例

要件

関連項目

フィードバック

その他のリソース