IMetadataInfo：：GetVrToken 方法

發行項
07/19/2023

擷取虛擬目錄所設定之模擬帳戶的 IHttpTokenEntry 介面。

語法

virtual IHttpTokenEntry* GetVrToken(  
   VOID  
) = 0;

參數

此方法不會採用任何參數。

傳回值

介面的 IHttpTokenEntry 指標。

備註

在 IIS 中建立指向網路共用的虛擬目錄時，您可以指定 IIS 在處理要求時用來連線到網路共用的模擬使用者名稱和密碼。然後 GetVrToken ，您可以使用方法來擷取 IHttpTokenEntry 模擬使用者的介面。

範例

下列程式碼範例示範如何使用 GetVrToken 方法來建立 HTTP 模組，以擷取 IHttpTokenEntry 針對虛擬目錄設定之模擬帳戶的介面。模組會將使用者權杖轉換為字串，並將字串傳回至 Web 用戶端。

#define _WINSOCKAPI_
#include <windows.h>
#include <sal.h>
#include <httpserv.h>
#define _WIN32_WINNT 0x0500
#include <sddl.h>

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

        // Retrieve a pointer to the IMetadataInfo interface.
        IMetadataInfo * pMetadataInfo = pHttpContext->GetMetadata();

        // Test for an error.
        if (NULL != pMetadataInfo)
        {
            // Retrieve the token key for the metadata interface.
            IHttpTokenEntry * pHttpTokenEntry = pMetadataInfo->GetVrToken();
            // Test for an error.
            if (NULL != pHttpTokenEntry)
            {
                // 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);
                // Retrieve the SID for the user associated with the metadata.
                PSID pSid = pHttpTokenEntry->GetSid();
                // Test for an error.
                if (NULL==pSid)
                {
                    // Return a message to the client that the SID is null.
                    WriteResponseMessage(pHttpContext,
                        "The metadata SID is ","null");
                }
                else
                {
                    // Test whether the SID is valid.
                    if (FALSE == IsValidSid(pSid))
                        // Return a message to the client that the SID is invalid.
                        WriteResponseMessage(pHttpContext,
                        "The metadata SID is ","invalid");
                    else
                    {
                        LPTSTR pszSid;
                        // Convert the SID to a string.
                        if (TRUE == ConvertSidToStringSid(pSid,&pszSid))
                        {
                            // Return a message to the client with the SID.
                            WriteResponseMessage(pHttpContext,
                                "The metadata SID is ",pszSid);
                        }
                    }
                }
                // 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 );

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

您的模組必須匯出 RegisterModule 函式。您可以為專案建立模組定義 (.def) 檔案，或使用參數編譯模組 /EXPORT:RegisterModule 來匯出此函式。如需詳細資訊，請參閱逐步解說：使用機器碼建立 Request-Level HTTP 模組。

您可以選擇性地使用呼叫慣例編譯器代碼， __stdcall (/Gz) 而不是明確宣告每個函式的呼叫慣例。

規格需求

類型	描述
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
標頭	Httpserv.h

另請參閱

IMetadataInfo 介面

共用方式為

IMetadataInfo：：GetVrToken 方法

語法

參數

傳回值

備註

範例

規格需求

另請參閱

意見反應

其他資源