IReadEntityProvider::Metode GetEntity

Mengambil entitas permintaan.

Sintaks

virtual VOID GetEntity(  
   PVOID* ppBuffer,  
   DWORD* pcbData,  
   DWORD* pcbBuffer  
) = 0;  

Parameter

ppBuffer
Penunjuk ke buffer kekosongan yang berisi entitas permintaan.

pcbData
Penunjuk ke yang DWORD berisi ukuran data di ppBuffer.

pcbBuffer
Penunjuk ke yang DWORD berisi ukuran ppBuffer buffer, yang harus lebih besar dari atau sama dengan pcbData.

Tampilkan Nilai

VOID.

Keterangan

Setelah Anda memanggil metode , ppBuffer parameter akan menentukan entitas permintaan; pcbData parameter akan menentukan ukuran, dalam byte, data dalam entitas permintaan yang dikembalikan dan ppBuffer;pcbBuffer parameter akan menentukan ukuran, dalam byte, dari buffer entitas permintaan yang diacu oleh ppBuffer.GetEntity

Catatan

pcbBuffer harus selalu lebih besar dari atau sama dengan pcbData.

Contoh

Contoh kode berikut menunjukkan cara membuat modul HTTP yang melakukan tugas berikut:

1. Mengambil entitas permintaan dengan menggunakan GetEntity metode .

2. Membuat array string yang berisi ukuran data entitas permintaan dan ukuran buffer.

3. Menulis entri log Pemampil Peristiwa yang berisi informasi entitas permintaan, lalu keluar.

#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
    )
    {
        UNREFERENCED_PARAMETER( pHttpContext );
        
        // Create buffers for the request entity information.
        PVOID pBuffer = NULL;
        DWORD cbData = 0;
        DWORD cbBuffer = 0;
        
        // Retrieve the request entity.
        pProvider->GetEntity(&pBuffer,&cbData,&cbBuffer);
        
        // Create string buffers for the return messages.
        char szData[30];
        char szBuffer[30];

        // Format the return messages.
        sprintf_s(szData,29,"Data Size: %u",cbData);
        sprintf_s(szBuffer,29,"Buffer Size: %u",cbBuffer);
        
        // Create an array of strings for the event viewer log.
        LPCSTR szReturn[3] = {"Request Entity Information",szData,szBuffer};
        // Write the strings to the Event Viewer.
        WriteEventViewerLog(szReturn,3);

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

    MyHttpModule()
    {
        // Open a handle to the Event Viewer.
        m_hEventLog = RegisterEventSource( NULL,"IISADMIN" );
    }

    ~MyHttpModule()
    {
        // Test whether the handle for the Event Viewer is open.
        if (NULL != m_hEventLog)
        {
            // Close the handle to the Event Viewer.
            DeregisterEventSource( m_hEventLog );
            m_hEventLog = NULL;
        }
    }

private:

    // Create a handle for the event viewer.
    HANDLE m_hEventLog;

    // Define a method that writes to the Event Viewer.
    BOOL WriteEventViewerLog(LPCSTR szBuffer[], WORD wNumStrings)
    {
        // Test whether the handle for the Event Viewer is open.
        if (NULL != m_hEventLog)
        {
            // Write any strings to the Event Viewer and return.
            return ReportEvent(
                m_hEventLog,
                EVENTLOG_INFORMATION_TYPE,
                0, 0, NULL, wNumStrings,
                0, szBuffer, NULL );
        }
        return FALSE;
    }
};

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

Modul Anda harus mengekspor fungsi RegisterModule . Anda dapat mengekspor fungsi ini dengan membuat file definisi modul (.def) untuk proyek Anda, atau Anda dapat mengkompilasi modul dengan menggunakan sakelar /EXPORT:RegisterModule . Untuk informasi selengkapnya, lihat Panduan: Membuat Modul HTTP Request-Level Dengan Menggunakan Kode Asli.

Anda dapat secara opsional mengkompilasi kode dengan menggunakan __stdcall (/Gz) konvensi panggilan alih-alih secara eksplisit mendeklarasikan konvensi panggilan untuk setiap fungsi.

Persyaratan

Jenis	Deskripsi
Klien	- IIS 7.0 di Windows Vista - IIS 7.5 di Windows 7 - IIS 8.0 di Windows 8 - IIS 10.0 pada Windows 10
Server	- IIS 7.0 di Windows Server 2008 - IIS 7.5 di Windows Server 2008 R2 - IIS 8.0 di Windows Server 2012 - IIS 8.5 di Windows Server 2012 R2 - IIS 10.0 di Windows Server 2016
Produk	- 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

Lihat juga

Antarmuka IReadEntityProvider
Metode IReadEntityProvider::SetEntity
Metode IHttpRequest::ReadEntityBody
Metode IHttpRequest::InsertEntityBody