IScriptMapInfo：：GetRequiredAccess 方法

發行項
07/19/2023

擷取腳本處理器的必要存取設定。

語法

virtual DWORD GetRequiredAccess(  
   VOID  
) const = 0;

參數

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

傳回值

DWORD，包含腳本處理器的必要存取設定。

備註

方法 GetRequiredAccess 會 requireAccess 擷取位於ApplicationHost.config檔案區段中之要求處理常式 <handlers> 的屬性。此屬性包含存取 (類型，例如要求處理常式所需的讀取、寫入等) 。必要存取設定的下列值定義在 IIS 的 Schema.xml 檔案中：

<attribute name="requireAccess" type="enum" defaultValue="Script">  
   <enum name="None" value="0" />  
   <enum name="Read" value="1" />  
   <enum name="Write" value="2" />  
   <enum name="Script" value="3" />  
   <enum name="Execute" value="4" />  
</attribute>

例如，當用戶端要求靜態檔案處理常式處理的檔案時，必要存取值為 1，因為靜態檔案處理常式預設需要唯讀存取。不過，INTERNET Server API (ISAPI) DLL 的要求會傳回值 4，因為需要執行存取權。

範例

下列程式碼範例示範如何使用 IHttpCoNtext：：GetScriptMap 方法來建立 HTTP 模組，以擷取 IScriptMapInfo 介面的指標。然後，此範例會 GetRequiredAccess 使用方法來擷取正在處理目前要求之要求處理常式的必要存取設定。模組會將必要存取設定轉換為字串、將字串傳回至 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)
        {
            // Clear the existing response.
            pHttpContext->GetResponse()->Clear();
            // Set the MIME type to plain text.
            pHttpContext->GetResponse()->SetHeader(
                HttpHeaderContentType,"text/plain",
                10,TRUE);

            // Create an array of required access strings.
            const char * szRequiredAccess[5] =
                {"None","Read","Write","Script","Execute"};

            // Retrieve the required access setting.
            DWORD dwRequiredAccess = pScriptMapInfo->GetRequiredAccess();

            // Test if the required access is within the bounds of the array.
            if ( dwRequiredAccess < 5 )
            {
                // Return the required access setting to the client.
                WriteResponseMessage(pHttpContext,
                    "Required access: ",szRequiredAccess[dwRequiredAccess]);
            }
            else
            {
                // Return an unspecified access setting to the client.
                WriteResponseMessage(pHttpContext,
                    "Required access: ","Unspecified");
            }

            // 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) 而不是明確宣告每個函式的呼叫慣例。

規格需求

類型	描述
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

另請參閱

IScriptMapInfo 介面

共用方式為

IScriptMapInfo：：GetRequiredAccess 方法

語法

參數

傳回值

備註

範例

規格需求

另請參閱

意見反應

其他資源