CHttpModule::OnReadEntity, méthode
Représente la méthode qui gérera un ReadEntity
événement, qui se produit lorsqu’une opération lit des données à partir de la mémoire tampon de requête.
Syntaxe
virtual REQUEST_NOTIFICATION_STATUS OnReadEntity(
IN IHttpContext* pHttpContext,
IN IReadEntityProvider* pProvider
);
Paramètres
pHttpContext
[IN] Pointeur vers une interface IHttpContext .
pProvider
[IN] Pointeur vers une interface IReadEntityProvider .
Valeur renvoyée
Valeur REQUEST_NOTIFICATION_STATUS .
Remarques
Lorsqu’un module au niveau de la demande s’est inscrit pour la notification d’événement RQ_READ_ENTITY , IIS appelle la méthode du OnReadEntity
module lorsqu’une opération lit les données de la mémoire tampon de requête.
Notes
Les modules au niveau de la demande peuvent s’inscrire à la PostReadEntity
notification d’événement en s’inscrivant à RQ_READ_ENTITY
dans la fonction RegisterModule du module.
Exemple
L’exemple suivant montre comment créer un module HTTP au niveau de la demande qui s’inscrit pour la notification d’événement RQ_READ_ENTITY
. Quand IIS lit des données à partir de la mémoire tampon de requête, il appelle la méthode de l’exemple de OnReadEntity
module. Une simple page HTML ou ASP.NET qui effectue une publication entraîne l’exécution de l’exemple de code.
#define _WINSOCKAPI_
#include <windows.h>
#include <sal.h>
#include <httpserv.h>
// Create the module class.
class MyHttpModule : public CHttpModule
{
public:
// Process an RQ_READ_ENTITY event.
REQUEST_NOTIFICATION_STATUS
OnReadEntity(
IN IHttpContext * pHttpContext,
IN IReadEntityProvider * pProvider
)
{
UNREFERENCED_PARAMETER( pHttpContext );
UNREFERENCED_PARAMETER( pProvider );
WriteEventViewerLog("OnReadEntity");
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 szNotification)
{
// 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, 1, 0, &szNotification, 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(
// Specify the class factory.
new MyHttpModuleFactory,
// Specify the event notifications.
RQ_READ_ENTITY,
// Specify no post-event notifications.
0
);
}
Spécifications
Type | Description |
---|---|
Client | - IIS 7.0 sur Windows Vista - IIS 7.5 sur Windows 7 - IIS 8.0 sur Windows 8 - IIS 10.0 sur Windows 10 |
Serveur | - IIS 7.0 sur Windows Server 2008 - IIS 7.5 sur Windows Server 2008 R2 - IIS 8.0 sur Windows Server 2012 - IIS 8.5 sur Windows Server 2012 R2 - IIS 10.0 sur Windows Server 2016 |
Produit | - 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 |
En-tête | Httpserv.h |