IReadEntityProvider::SetEntity メソッド

要求エンティティを指定します。

構文

virtual VOID SetEntity(  
   PVOID pBuffer,  
   DWORD cbData,  
   DWORD cbBuffer  
) = 0;  

パラメーター

pBuffer
要求エンティティを含む void バッファーへのポインター。

cbData
DWORD内のデータpBufferのサイズを格納している 。

cbBuffer
DWORDバッファーのpBufferサイズを格納する 。 以上cbDataにする必要があります。

戻り値

VOID.

注釈

メソッドは SetEntity 、事前に読み込まれた HTTP 要求エンティティ本文を、 パラメーターが pBuffer 指すエンティティ本体に置き換えます。 パラメーターでは cbData 、 で返された要求エンティティ内のデータのサイズ (バイト単位) pBufferを指定する必要があります cbBuffer 。パラメーターでは、 が pBuffer指す要求エンティティ バッファーのサイズ (バイト単位) を指定する必要があります。

注意

cbBuffer は常に 以上 cbDataである必要があります。

例

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

1. 1 KB のバッファーを割り当てます。 バッファーを割り当てることができない場合、モジュールはエラーを返して終了します。

2. 応答値を含む文字列を作成します。

3. メソッドを使用して要求エンティティを SetEntity 指定し、終了します。

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

// NOTE - Data needs to be passed to this module, e.g. a POST request, or it will not appear to return anything.

// Create the module class.
class MyHttpModule : public CHttpModule
{
public:
    REQUEST_NOTIFICATION_STATUS
    OnReadEntity(
        IN IHttpContext * pHttpContext,
        IN IReadEntityProvider * pProvider
    )
    {
        // Allocate a 1K buffer for the request entity.
        DWORD cbBuffer = 1024;
        void * pvBuffer = pHttpContext->AllocateRequestMemory(cbBuffer);
        
        // Test for an error.
        if (NULL == pvBuffer)
        {
            // Set the error status.
            pProvider->SetErrorStatus(
                HRESULT_FROM_WIN32(ERROR_NOT_ENOUGH_MEMORY));
            // End additional processing.
            return RQ_NOTIFICATION_FINISH_REQUEST;
        }

        // Create a string to return.
        char szBuffer[] = "Name=Value";
        // Specify the exact data length.
        DWORD cbData = (DWORD) strlen(szBuffer);        
        // Copy a string into the request entity buffer.
        strcpy_s((char*)pvBuffer,cbBuffer,szBuffer);
        // Set the request entity to the buffer.
        pProvider->SetEntity(pvBuffer,cbData,cbBuffer);

        // Return processing to the pipeline.
        return RQ_NOTIFICATION_CONTINUE;
    }
};

// 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_READ_ENTITY,
        0
    );
}

モジュールで 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

参照

IReadEntityProvider インターフェイス
IReadEntityProvider::GetEntity メソッド
IHttpRequest::ReadEntityBody メソッド
IHttpRequest::InsertEntityBody メソッド