IHttpServer::GetFileInfo メソッド

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

特定のファイルパスの IHttpFileInfo インターフェイスを返します。

構文

virtual HRESULT GetFileInfo(  
   IN PCWSTR pszPhysicalPath,  
   IN HANDLE hUserToken,  
   IN PSID pSid,  
   IN PCWSTR pszVrPath,  
   IN HANDLE hVrToken,  
   IN BOOL fCache,  
   OUT IHttpFileInfo** ppFileInfo,  
   IN IHttpTraceContext* pHttpTraceContext = NULL  
) = 0;

パラメーター

pszPhysicalPath
[IN]ファイルへの物理パスを含む文字列へのポインター。

hUserToken
[IN] HANDLE 偽装ユーザーのトークンを格納している。それ以外の場合は NULL。

pSid
[IN]偽装ユーザーのセキュリティ ID を含むセキュリティ識別子 (SID) へのポインター。それ以外の場合は NULL。

pszVrPath
[IN]変更通知に登録する仮想パスを含む文字列へのポインター。それ以外の場合は NULL。

hVrToken
[IN] HANDLE 変更通知に登録する偽装トークンを格納している。それ以外の場合は NULL。

fCache
[IN] true ファイルをキャッシュする必要があることを示す場合は。それ以外の場合は false。

ppFileInfo
[OUT]インターフェイスへの IHttpFileInfo 逆参照ポインター。

pHttpTraceContext
[IN]オプションの IHttpTraceContext インターフェイスへのポインター。

戻り値

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

値	定義
S_OK	操作が成功したことを示します。
E_FAIL	モジュールホストが終了している間にの `GetFileInfo` 呼び出しが行われたことを示します。

解説

メソッドは IHttpServer::GetFileInfo 、特定の IHttpFileInfo パスのインターフェイスを作成します。このメソッドは、IIS が要求コンテキスト内で処理しているファイルのインターフェイスをIHttpFileInfo返す IHttpContext::GetFileInfo メソッドとは異なります。

インターフェイスを pszPhysicalPath 作成するには、パラメーターと ppFileInfo パラメーターが IHttpFileInfo 必要です。パラメーターは pszPhysicalPath ファイルへのパスを指定し ppFileInfo 、パラメーターは IIS が対応する IHttpFileInfo インターフェイスで設定するポインターを定義します。

pszVrPathパラメーターと hVrToken パラメーターは省略可能であり、使用しない場合は NULL に設定する必要があります。これらのパラメーターは、モジュールが変更通知に登録するときに使用する仮想パスと偽装トークンをそれぞれ指定します (たとえば、パラメーターをにtrue設定fCacheしてキャッシュを要求する場合)。

注意

その他の構成設定では、パラメーターにを指定truefCacheした場合でも、IIS でファイルがキャッシュされないことがあります。

hUserTokenパラメーターと pSid パラメーターも省略可能であり、使用しない場合は NULL に設定する必要があります。これらのパラメーターは、偽装ユーザーのトークンと SID をそれぞれ指定します。残りの省略可能なパラメーターは、 pHttpTraceContextトレースの IHttpTraceContext インターフェイスを指定します。

例

次のコード例では、次のタスクを実行する HTTP モジュールを作成する方法を示します。

RQ_BEGIN_REQUEST通知に登録します。
OnBeginRequest メソッドを含む CHttpModule クラスを作成します。クライアントがファイルを要求すると、メソッドは OnBeginRequest 次のタスクを実行します。
1. IHttpContext::MapPath メソッドを使用して、相対 URL へのパスをマップします。
2. メソッドを IHttpFileInfo 使用して、ファイルパスのインターフェイスを IHttpServer::GetFileInfo 作成します。
3. IHttpFileInfo::GetETag メソッドを使用して、ファイルのエンティティタグを取得します。
4. IHttpResponse::WriteEntityChunks メソッドを使用して、エンティティタグをクライアントに返します。
クラスを CHttpModule メモリから削除し、終了します。

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

        HRESULT hr;

        PWSTR wszUrl = L"/example/default.asp";
        WCHAR wszPhysicalPath[1024] = L"";
        DWORD cbPhysicalPath = 1024;

        pHttpContext->MapPath(wszUrl,wszPhysicalPath,&cbPhysicalPath);

        if (NULL != wszPhysicalPath)
        {
            IHttpFileInfo * pHttpFileInfo;
            hr = g_pHttpServer->GetFileInfo(wszPhysicalPath,
                NULL,NULL,wszUrl,NULL,TRUE,&pHttpFileInfo);
            if (NULL != pHttpFileInfo)
            {
                // Create a buffer for the Etag.
                USHORT cchETag;
                // Retrieve the Etag.
                PCSTR pszETag = pHttpFileInfo->GetETag(&cchETag);
                //Test for an error.
                if (NULL != pszETag)
                {
                    // 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 Etag to the client.
                    WriteResponseMessage(pHttpContext,
                        "ETag: ",pszETag);
                    // 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. (Defined in the Http.h file.)
        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
    );
}

ネイティブ DLL モジュールを作成してデプロイする方法の詳細については、「チュートリアル: ネイティブコードを使用した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

参照

IHttpServer インターフェイス
 IHttpContext::GetFileInfo メソッド

次の方法で共有

IHttpServer::GetFileInfo メソッド

構文

パラメーター

戻り値

解説

例

要件

参照

フィードバック

その他のリソース