IGlobalRSCAQueryProvider::GetFunctionName, méthode
Retourne le nom de l’appel de fonction dynamique qui a provoqué l’événement.
Syntaxe
virtual PCWSTR GetFunctionName(
VOID
) const = 0;
Paramètres
Cette méthode ne prend aucun paramètre.
Valeur renvoyée
Pointeur vers une chaîne Unicode terminée par un caractère Null constant qui contient le nom de la fonction à l’origine de l’événement.
Remarques
Les classes dérivées CGlobalModule qui s’inscrivent pour GL_RSCA_QUERY événements reçoivent un pointeur IGlobalRscaQueryProvider en tant que paramètre sur la méthode CGlobalModule::OnGlobalRSCAQueryvirtual. Vous pouvez ensuite récupérer le nom de la fonction en appelant la GetFunctionName méthode sur le IGlobalRSCAQueryProvider pointeur.
La valeur de retour de la méthode dépend de l’implémentation GetFunctionName . Vous devez utiliser les informations suivantes comme recommandations, mais elles peuvent ne pas être correctes dans tous les scénarios :
L’implémenteur par défaut des interfaces IProtocolManager, IPmCustomActions, IPmHealthAndIdleMonitor et IPmListenerChannelManager déclenche des événements lorsque vous appelez les méthodes IRSCA_WorkerProcess::EnumerateAppDomains et IRSCA_AppDomain::Unload . Ces méthodes sont mappées aux valeurs PMH_App_Domain_Enum_V1 et PMH_App_Domain_Unload_V1, respectivement, qui sont retournées lorsque vous appelez
GetFunctionName. Les paramètres de cette fonction sont, à leur tour, retournés lorsque vous appelez la méthode GetFunctionParameters .L’implémenteur
IGlobalRSCAQueryProviderreçoit le nom de la fonction et les valeurs de paramètre de fonction sous forme de chaînes lorsque l’un des événements IRSCA_AppDomain est déclenché, et l’implémenteur conserve des références à ces chaînes. Si une chaîne a la valeur NULL,GetFunctionNameretourne la chaîne vide. Sinon,GetFunctionNameretourne un pointeur vers cette chaîne partagée.
Remarques pour les implémenteurs
IGlobalRSCAQueryProvider les implémenteurs sont responsables de la gestion de la mémoire avec ces données ; Par conséquent, IGlobalRSCAQueryProvider les implémenteurs qui utilisent l’allocation de mémoire dynamique doivent libérer ou appeler delete le PCWSTR pointeur lorsqu’il n’est plus nécessaire.
Remarques pour les appelants
IGlobalRSCAQueryProvider les implémenteurs sont responsables de la gestion de la mémoire avec ces données ; Par conséquent, IGlobalRSCAQueryProvider les clients ne doivent pas libérer ou appeler delete sur le pointeur retourné PCWSTR lorsque ces données ne sont plus nécessaires. En outre, les clients ne doivent pas convertir ces données en pointeur qui n’est pas un const pointeur ou modifier l’état de la mémoire référencée par ce PCWSTR, car une violation d’accès sera déclenchée ou les données deviendront non valides.
Exemple
L’exemple de code suivant montre comment créer un module global qui écoute les événements GL_RSCA_QUERY, puis écrit les informations de nom de fonction dans le observateur d'événements.
Attention
IIS 7 génère un grand nombre d’événements dans le observateur d'événements. Pour éviter une erreur de dépassement de journal dans un environnement de production, vous devez généralement éviter d’écrire des informations de cache dans le journal des événements. À des fins de démonstration, cet exemple de code écrit une entrée dans le observateur d'événements en mode débogage uniquement.
#define _WINSOCKAPI_
#include <windows.h>
#include <sal.h>
#include <tchar.h>
#include <httpserv.h>
#include <string>
using namespace std;
// The CConvert class mirrors the Convert class that is
// defined in the .NET Framework. It converts primitives
// and other data types to wstring types.
class CConvert
{
public:
// The ToByteString converts a double-byte
// character string to a single-byte string.
// str: the double-byte string to convert.
// return: a single-byte string copied from str.
static string ToByteString(const wstring& str)
{
// Get the length of the
// double-byte string.
size_t length = str.length();
// Create a temporary char pointer.
char* byteChar = new char[length+1];
byteChar[0] = '\0';
// Copy the double-byte character string
// into the single-byte string.
size_t charsReturned = 0;
wcstombs_s(&charsReturned, byteChar,
length+1, str.c_str(), length+1);
// Create a string to return.
string retString = byteChar;
// Delete the temporary string and
// set that string to NULL.
delete[] byteChar;
byteChar = NULL;
// Return the single-byte string.
return retString;
}
};
// The CEventWriter class writes XML
// documents and strings to the event log.
class CEventWriter
{
public:
// Creates the CEventWriter class.
// name: the name of the
// event log to open.
CEventWriter(const wstring& name)
{
#ifdef UNICODE
m_eventLog = RegisterEventSource(NULL, name.c_str());
#else
string multiName = CConvert::ToByteString(name);
m_eventLog = RegisterEventSource(NULL, multiName.c_str());
#endif
}
// Creates the destructor for the
// CEventWriter class. This destructor
// closes the HANDLE to the event
// log if that HANDLE is open.
virtual ~CEventWriter()
{
// If the HANDLE to the event
// log is open, close it.
if (NULL != m_eventLog)
{
// Deregister the event log HANDLE.
DeregisterEventSource(m_eventLog);
// Set the HANDLE to NULL.
m_eventLog = NULL;
}
}
// The ReportInfo method writes
// a wstring to the event log.
// info: the wstring to write.
// return: true if the event log is written.
BOOL ReportInfo(const wstring& info)
{
return ReportEvent(EVENTLOG_INFORMATION_TYPE, info);
}
protected:
// The ReportEvent method accepts an event type
// and a wstring, and attempts to write that
// event to the event log.
// type: the type of the event.
// data: the wstring to write to the event log.
// return: true if the event log is written;
// otherwise, false.
BOOL ReportEvent(WORD type, const wstring& data)
{
// If the m_eventLog HANDLE
// is NULL, return false.
if (NULL == m_eventLog)
{
return FALSE;
}
#ifndef _DEBUG
// If the current build is not debug,
// return so the event log is not written.
return TRUE;
#endif
#ifdef UNICODE
// The unicode version of the ReportEvent
// method requires double-byte strings.
PCWSTR arr[1];
arr[0] = data.c_str();
return ::ReportEvent(m_eventLog,
type,
0, 0, NULL, 1,
0, arr, (void*)arr);
#else
// The non-unicode version of the ReportEvent
// method requires single-byte strings.
string multiByte =
CConvert::ToByteString(data);
LPCSTR arr[1];
arr[0] = multiByte.c_str();
return ::ReportEvent(m_eventLog,
type,
0, 0, NULL, 1,
0, arr, (void*)arr);
#endif
}
private:
// Specify the HANDLE to the
// event log for writing.
HANDLE m_eventLog;
};
// The CRSCAGlobalModule class creates the CGlobalModule
// class and registers for GL_RSCA_QUERY and events.
class CRSCAGlobalModule : public CGlobalModule
{
public:
// Creates the destructor for the
// CGlobalCacheModule class.
virtual ~CRSCAGlobalModule()
{
}
// The RegisterGlobalModule method creates and registers
// a new CRSCAGlobalModule for GL_RSCA_QUERY events.
// dwServerVersion: the current server version.
// pModuleInfo: the current IHttpModuleRegistrationInfo pointer.
// pGlobalInfo: the current IHttpServer pointer.
// return: E_INVALIDARG if the IHttpServer pointer
// is NULL; ERROR_NOT_ENOUGH_MEMORY if the heap is out of
// memory; otherwise, the value from the call to the
// SetGlobalNotifications method on the pModuleInfo pointer.
static HRESULT RegisterGlobalModule
(
DWORD dwServerVersion,
IHttpModuleRegistrationInfo* pModuleInfo,
IHttpServer* pGlobalInfo
)
{
// The pGlobalInfo parmeter must be
// non-NULL because the constructor
// for the CGlobalCacheModule class
// requires a non-NULL pointer to a
// valid IHttpServer pointer.
if (NULL == pGlobalInfo)
{
return E_INVALIDARG;
}
// Create a new CGlobalCacheModule pointer.
CRSCAGlobalModule* rscaModule =
new CRSCAGlobalModule();
// Return an out-of-memory error
// if the traceModule is NULL
// after the call to the new operator.
if (NULL == rscaModule)
{
return HRESULT_FROM_WIN32(ERROR_NOT_ENOUGH_MEMORY);
}
// Attempt to set global notification
// for GL_RSCA_QUERY events by using
// the rscaModule as a listener.
HRESULT hr = pModuleInfo->SetGlobalNotifications
(rscaModule, GL_RSCA_QUERY);
// Return the HRESULT from the call to
// the SetGlobalNotifications method.
return hr;
}
// The OnGlobalRSCAQuery method is the event
// handler method for the GL_RSCA_QUERY event.
// pProvider: the IGlobalRSCAQueryProvider pointer.
// return: GL_NOTIFICATION_CONTINUE.
virtual GLOBAL_NOTIFICATION_STATUS OnGlobalRSCAQuery
(
IN IGlobalRSCAQueryProvider* pProvider
)
{
// Return GL_NOTIFICATION_CONTINUE if the
// IGlobalRSCAQueryProvider pointer is NULL.
if (NULL == pProvider)
{
return GL_NOTIFICATION_CONTINUE;
}
// Get the name of the function from
// the IGlobalRSCAQueryProvider pointer.
wstring functionName =
pProvider->GetFunctionName();
// Write the function name
// information to the event writer.
m_eventWriter.ReportInfo
(L"Function Name: " + functionName);
// Return GL_NOTIFICATION_CONTINUE so
// other listeners will receive this event.
return GL_NOTIFICATION_CONTINUE;
}
// The Terminate method is a pure virtual
// method that all non-abstract CGlobalModule
// classes must implement. Calls delete on this.
virtual VOID Terminate(VOID)
{
delete this;
}
protected:
// Creates the CRSCAGlobalModule class.
// Initializes the CEventWriter to write
// to the event log using the IISADMIN key.
CRSCAGlobalModule() : m_eventWriter(L"IISADMIN")
{
}
private:
// Specify the CEventWriter writer.
CEventWriter m_eventWriter;
};
// The RegisterModule method is the
// main entry point for the DLL.
// dwServerVersion: the current server version.
// pModuleInfo: the current
// IHttpModuleRegistrationInfo pointer.
// pGlobalInfo: the current IHttpServer pointer.
// return: the value returned by calling the
// CRSCAGlobalModule::RegisterGlobalModule
// method.
HRESULT
__stdcall
RegisterModule(
DWORD dwServerVersion,
IHttpModuleRegistrationInfo* pModuleInfo,
IHttpServer* pGlobalInfo
)
{
// Call the static method for initialization.
return CRSCAGlobalModule::RegisterGlobalModule
(dwServerVersion,
pModuleInfo,
pGlobalInfo);
}
Pour plus d’informations sur la création et le déploiement d’un module DLL natif, consultez Procédure pas à pas : création d’un module HTTP Request-Level à l’aide de code natif.
Le code ci-dessus écrit deux nouveaux événements dans le journal des applications du observateur d'événements, où la zone Données contient une chaîne similaire à la suivante :
Function Name: PMH_App_Domain_Enum_V1
Vous pouvez éventuellement compiler le code à l’aide de la convention d’appel __stdcall (/Gz) au lieu de déclarer explicitement la convention d’appel pour chaque fonction.
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 |