IHttpContext::GetUser メソッド

現在のコンテキストのユーザー情報コンテナーを取得します。

構文

virtual IHttpUser* GetUser(  
   VOID  
) const = 0;  

パラメーター

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

戻り値

IHttpUser インターフェイスへのポインター。

解説

メソッドは GetUser インターフェイスを IHttpUser 返します。このインターフェイスには、現在の要求のセキュリティ関連情報を取得するためのいくつかのメソッドが含まれています。 たとえば、 IHttpUser::GetUserName メソッドと IHttpUser::GetPassword メソッドを使用して、認証されたユーザーのユーザー資格情報を取得できます。

例

次のコード例では、 メソッドを使用して、インターフェイスを GetUser 取得する HTTP モジュールを作成する方法を IHttpUser 示します。 次に、 メソッドを IHttpUser::GetUserName 使用して現在のユーザー名を取得します。 Web サイトが匿名認証を使用している場合、ユーザー名は空白になり、HTTP モジュールは Web サイトが匿名認証を使用していることを示すメッセージを返します。 それ以外の場合、HTTP モジュールは現在のユーザー名を Web クライアントに返します。

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

// Create the module class.
class MyHttpModule : public CHttpModule
{
public:

    REQUEST_NOTIFICATION_STATUS
    OnSendResponse(
        IN IHttpContext * pHttpContext,
        IN ISendResponseProvider * pProvider
    )
    {
        UNREFERENCED_PARAMETER( pProvider );

        // Clear the existing response.
        pHttpContext->GetResponse()->Clear();

        // Create an HRESULT to receive return values from methods.
        HRESULT hr;

        // Create pointers for the user name buffers.
        PCWSTR pwszUserName;
        char*  pszUserName;

        // Retrieve the IHttpUser interface.
        IHttpUser * pHttpUser = pHttpContext->GetUser();

        // Test for an error.
        if (pHttpUser != NULL)
        {
            // Retrieve the user name.
            pwszUserName = pHttpUser->GetUserName();
            // Test for an error.
            if (pwszUserName!=NULL)
            {
                // Test for anonymous user.
                if (0==wcslen(pwszUserName))
                {
                    // Return the anonymous user information to the web client.
                    WriteResponseMessage(pHttpContext,
                        "User name: ","ANONYMOUS");
                }
                else
                {
                    // Allocate space for the user name.
                    pszUserName = (char*) pHttpContext->AllocateRequestMemory( (DWORD) wcslen(pwszUserName)+1 );
                    // Test for an error.
                    if (pszUserName==NULL)
                    {
                        // Set the error status.
                        hr = HRESULT_FROM_WIN32(ERROR_NOT_ENOUGH_MEMORY);
                        pProvider->SetErrorStatus( hr );
                    }
                    else
                    {
                        // Return the user information to the Web client.
                        wcstombs(pszUserName,pwszUserName,wcslen(pwszUserName));
                        WriteResponseMessage(pHttpContext,
                            "User name: ",pszUserName);
                    }
                    // 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,
        RQ_SEND_RESPONSE,
        0
    );
}

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

各関数の呼び出し規約を __stdcall (/Gz) 明示的に宣言する代わりに、呼び出し規約を使用してコードをコンパイルできます。

要件

参照

IHttpContext インターフェイス
IHttpUser インターフェイス