IHttpServer::GetConfigObject-Methode
Ruft das Konfigurationsobjekt für den aktuellen Kontext ab.
Syntax
virtual INativeConfigurationSystem* GetConfigObject(
VOID
) const = 0;
Parameter
Diese Methode nimmt zwei Parameter entgegen.
Rückgabewert
Ein Zeiger auf eine INativeConfigurationSystem-Schnittstelle .
Bemerkungen
Die GetConfigObject -Methode ruft ein Konfigurationsobjekt ab, mit dem Sie Konfigurationseinstellungen aus einer Konfigurationsdatei abrufen können. Beispielsweise ruft die INativeConfigurationSystem::GetConfigSection-Methode eine INativeConfigurationElement-Schnittstelle ab, die ein Containerobjekt für einen Abschnitt der Konfigurationseinstellungen für den aktuellen Kontext ist. Dieses Containerobjekt enthält mehrere Methoden, mit denen Sie die Konfigurationseinstellungen abrufen oder ändern können.
Beispiel
Im folgenden Codebeispiel wird veranschaulicht, wie Sie ein HTTP-Modul erstellen, das die IHttpContext::GetMetadata-Methode verwendet, um einen Zeiger auf eine IMetadataInfo-Schnittstelle abzurufen. Das Modul führt die folgenden Schritte aus:
Verwendet die IMetadataInfo::GetMetaPath-Methode , um den Konfigurationspfad für die aktuelle Anforderung abzurufen.
Verwendet die
GetConfigObject-Methode, um einen Zeiger auf eineINativeConfigurationSystemSchnittstelle abzurufen.Übergibt den Konfigurationspfad für die aktuelle Anforderung an die
INativeConfigurationSystem::GetConfigSection-Methode.Ruft eine
INativeConfigurationElementSchnittstelle für die Protokolleinstellungen für IIS ab.Verwendet die INativeConfigurationElement::GetBooleanProperty-Methode , um einen Wert abzurufen, der angibt, ob die Protokollierung für den aktuellen Anforderungskontext aktiviert ist.
Gibt diese Informationen an einen Webclient zurück und wird dann beendet.
#define _WINSOCKAPI_
#include <windows.h>
#include <sal.h>
#include <httpserv.h>
// Create a pointer for the global server interface.
IHttpServer * g_pHttpServer = NULL;
// Create the module class.
class MyHttpModule : public CHttpModule
{
public:
REQUEST_NOTIFICATION_STATUS
OnBeginRequest(
IN IHttpContext * pHttpContext,
IN IHttpEventProvider * pProvider
)
{
UNREFERENCED_PARAMETER( pProvider );
// Create an HRESULT to receive return values from methods.
HRESULT hr;
// Create a boolean variable for the configuration setting.
BOOL fDoNotLog = FALSE;
// Create pointers to configuration objects.
INativeConfigurationSystem * pConfigSystem = NULL;
INativeConfigurationElement * pConfigElement = NULL;
// Retrieve a pointer to the IMetadataInfo interface.
IMetadataInfo * pMetadataInfo = pHttpContext->GetMetadata();
// Retrieve the configuration path.
PCWSTR pwszConfigPath = pMetadataInfo->GetMetaPath();
// Retrieve the configuration object.
pConfigSystem = g_pHttpServer->GetConfigObject();
// Test for an error.
if (NULL != pConfigSystem)
{
// Retrieve the HTTP logging configuration section.
hr = pConfigSystem->GetConfigSection(
L"system.webServer/httpLogging",
pwszConfigPath,&pConfigElement,NULL,NULL);
// Test for an error.
if (SUCCEEDED(hr))
{
// Retrieve the log settings from the configuration section.
hr = pConfigElement->GetBooleanProperty(
L"dontLog",&fDoNotLog,NULL);
// Test for an error.
if (SUCCEEDED(hr))
{
// Clear the existing response.
pHttpContext->GetResponse()->Clear();
// Set the MIME type to plain text.
pHttpContext->GetResponse()->SetHeader(
HttpHeaderContentType,"text/plain",
(USHORT)strlen("text/plain"),TRUE);
// Allocate space for the configuration path.
PSTR pszConfigPath =
(PSTR) pHttpContext->AllocateRequestMemory(
(DWORD) wcslen(pwszConfigPath) + 1 );
// Test for an error.
if (NULL == pszConfigPath)
{
// Set the error status.
hr = HRESULT_FROM_WIN32(ERROR_NOT_ENOUGH_MEMORY);
pProvider->SetErrorStatus( hr );
// End additional processing.
return RQ_NOTIFICATION_FINISH_REQUEST;
}
// Convert the WCHAR string to a CHAR string.
wcstombs(pszConfigPath,
pwszConfigPath,wcslen(pwszConfigPath));
// Return the configuration path.
WriteResponseMessage(pHttpContext,
"\nConfiguration path:\t",pszConfigPath);
// Return the configuration setting.
WriteResponseMessage(pHttpContext,"\nLogging enabled:\t",
(FALSE == fDoNotLog) ? "Yes" : "No");
// 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 );
// Store the pointer for the global server interface.
g_pHttpServer = pGlobalInfo;
// Set the request notifications and exit.
return pModuleInfo->SetRequestNotifications(
new MyHttpModuleFactory,
RQ_BEGIN_REQUEST,
0
);
}
Ihr Modul muss die RegisterModule-Funktion exportieren. Sie können diese Funktion exportieren, indem Sie eine Moduldefinitionsdatei (.def) für Ihr Projekt erstellen, oder Sie können das Modul mithilfe des Schalters /EXPORT:RegisterModule kompilieren. Weitere Informationen finden Sie unter Exemplarische Vorgehensweise: Erstellen eines Request-Level HTTP-Moduls mithilfe von nativem Code.
Sie können den Code optional kompilieren, indem Sie die __stdcall (/Gz) Aufrufkonvention verwenden, anstatt die Aufrufkonvention für jede Funktion explizit zu deklarieren.
Anforderungen
| type | BESCHREIBUNG |
|---|---|
| Client | – IIS 7.0 unter Windows Vista – IIS 7.5 unter Windows 7 – IIS 8.0 unter Windows 8 – IIS 10.0 unter Windows 10 |
| Server | – IIS 7.0 unter Windows Server 2008 – IIS 7.5 unter Windows Server 2008 R2 – IIS 8.0 unter Windows Server 2012 – IIS 8.5 unter Windows Server 2012 R2 – IIS 10.0 unter Windows Server 2016 |
| Produkt | – 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 |
Weitere Informationen
Feedback
Bald verfügbar: Im Laufe des Jahres 2024 werden wir GitHub-Issues stufenweise als Feedbackmechanismus für Inhalte abbauen und durch ein neues Feedbacksystem ersetzen. Weitere Informationen finden Sie unter https://aka.ms/ContentUserFeedback.
Feedback senden und anzeigen für