Método IScriptMapInfo::GetModules
Recupera a lista de módulos para um manipulador de solicitação.
Sintaxe
virtual PCWSTR GetModules(
DWORD* pcchModules = NULL
) const = 0;
Parâmetros
pcchModules
Um ponteiro para um DWORD buffer que recebe o comprimento, em caracteres, da lista de módulos.
Valor Retornado
Um ponteiro para uma cadeia de caracteres que contém uma lista delimitada por vírgulas de módulos.
Comentários
O GetModules método recupera o modules atributo de um manipulador de solicitação localizado na <handlers> seção do arquivo ApplicationHost.config. Esse atributo contém uma lista delimitada por vírgulas de módulos para o manipulador de solicitação.
Por exemplo, se um cliente Web solicitar uma página ASP clássica, GetModules retornará "IsapiModule" por padrão. Se um cliente solicitar um arquivo estático, GetModules retornará uma lista delimitada por vírgulas que contém "StaticFileModule", "DefaultDocumentModule" e "DirectoryListingModule" por padrão.
Exemplo
O exemplo de código a seguir demonstra como usar o método IHttpContext::GetScriptMap para criar um módulo HTTP que recupera um ponteiro para uma interface IScriptMapInfo . Em seguida, o exemplo usa o GetModules método para recuperar a lista de módulos para o manipulador de solicitação que está processando a solicitação atual. O módulo retorna a lista de módulos para um cliente Web e, em seguida, é encerrado.
#define _WINSOCKAPI_
#include <windows.h>
#include <sal.h>
#include <httpserv.h>
// Create the module class.
class MyHttpModule : public CHttpModule
{
public:
REQUEST_NOTIFICATION_STATUS
OnPostMapRequestHandler(
IN IHttpContext * pHttpContext,
IN IHttpEventProvider * pProvider
)
{
UNREFERENCED_PARAMETER( pProvider );
// Retrieve the IScriptMapInfo interface.
IScriptMapInfo * pScriptMapInfo = pHttpContext->GetScriptMap();
// Create an HRESULT to receive return values from methods.
HRESULT hr;
// Test for an error.
if (NULL != pScriptMapInfo)
{
// Create buffers to store the module list.
PCWSTR pwszModules;
PSTR pszModules;
DWORD cchModules = 0;
// Retrieve the module list.
pwszModules = pScriptMapInfo->GetModules(&cchModules);
// Test for an error.
if (NULL != pwszModules)
{
// 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);
// Test the length of the module list.
if (cchModules > 0)
{
// Allocate space to store data.
pszModules =
(PSTR) pHttpContext->AllocateRequestMemory
(cchModules + 1);
// Test for an error.
if (NULL == pszModules)
{
// 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(pszModules,
pwszModules,cchModules);
}
// Return the list of modules to the client.
WriteResponseMessage(pHttpContext,"Modules: ",
(cchModules>0) ? pszModules : "n/a");
// 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 );
UNREFERENCED_PARAMETER( pGlobalInfo );
// Set the request notifications and exit.
return pModuleInfo->SetRequestNotifications(
new MyHttpModuleFactory,
0,
RQ_MAP_REQUEST_HANDLER
);
}
Seu módulo deve exportar a função RegisterModule . Você pode exportar essa função criando um arquivo de definição de módulo (.def) para seu projeto ou pode compilar o módulo usando a opção /EXPORT:RegisterModule . Para obter mais informações, consulte Passo a passo: criando um módulo HTTP Request-Level usando código nativo.
Opcionalmente, você pode compilar o código usando a __stdcall (/Gz) convenção de chamada em vez de declarar explicitamente a convenção de chamada para cada função.
Requisitos
| Type | Descrição |
|---|---|
| Cliente | - IIS 7.0 no Windows Vista - IIS 7.5 no Windows 7 - IIS 8.0 no Windows 8 - IIS 10.0 no Windows 10 |
| Servidor | - IIS 7.0 no Windows Server 2008 - IIS 7.5 no Windows Server 2008 R2 - IIS 8.0 no Windows Server 2012 - IIS 8.5 no Windows Server 2012 R2 - IIS 10.0 no Windows Server 2016 |
| Produto | - 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 |
| parâmetro | Httpserv.h |