IHttpServer::GetWorkerProcessSettings (Método)
Recupera una interfaz IWpfSettings .
Sintaxis
virtual HRESULT GetWorkerProcessSettings(
IWpfSettings** ppWorkerProcessSettings
) = 0;
Parámetros
ppWorkerProcessSettings
Puntero desreferenciado a una interfaz IWpfSettings .
Valor devuelto
Una clase HRESULT. Entre los valores posibles se incluyen los que se indican en la tabla siguiente, entre otros.
| Value | Descripción |
|---|---|
| S_OK | Indica que la operación se realizó correctamente. |
Comentarios
El GetWorkerProcessSettings método permite a los desarrolladores recuperar información de configuración sobre el marco de proceso de trabajo a través de una interfaz IWpfSettings .
Nota
El servidor controla la duración y el recuento de referencias para IWpfSettings.
IWpfSettings expone varios métodos que puede usar para recuperar información específica sobre el marco de proceso de trabajo. Por ejemplo, el método IWpfSettings::GetDwordProperty permite recuperar la configuración de IDLE_TIMEOUT o PERIODIC_RESTART_TIME .
Ejemplo
En el ejemplo de código siguiente se muestra cómo usar el GetWorkerProcessSettings método para crear un módulo HTTP que recupere la versión de Common Language Runtime (CLR) en el servidor. A continuación, el módulo devuelve esa información a un cliente web.
#define _WINSOCKAPI_
#include <windows.h>
#include <sal.h>
#include <httpserv.h>
#include <wpframework.h>
// Create a pointer for the global server interface.
IHttpServer * g_pGlobalInfo = 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 pointer to an IWpfSettings class.
IWpfSettings * pWpfSettings;
// Retrieve the IWpfSettings class.
hr = g_pGlobalInfo->GetWorkerProcessSettings(&pWpfSettings);
// Test for an error.
if (SUCCEEDED(hr))
{
PWSTR pwszSetting = NULL;
DWORD cchSetting = 1024;
PSTR pszSetting = NULL;
// Allocate space for the strings.
pwszSetting = (PWSTR) pHttpContext->AllocateRequestMemory( cchSetting + 1 );
pszSetting = (PSTR) pHttpContext->AllocateRequestMemory( cchSetting + 1 );
// Test for an error.
if ((NULL == pwszSetting) || (NULL == pszSetting))
{
// Set the error status.
hr = HRESULT_FROM_WIN32(ERROR_NOT_ENOUGH_MEMORY);
pProvider->SetErrorStatus( hr );
// End additional processing.
return RQ_NOTIFICATION_FINISH_REQUEST;
}
// Retrieve the CLR version.
hr = pWpfSettings->GetStringProperty(CLR_VERSION,pwszSetting,&cchSetting);
// Test for an error.
if (SUCCEEDED(hr))
{
// Convert the WCHAR string to a CHAR string.
wcstombs(pszSetting,pwszSetting,cchSetting);
// 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);
// Return the CLR version to the client.
WriteResponseMessage(pHttpContext,
"CLR Version: ",pszSetting);
// 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_pGlobalInfo = pGlobalInfo;
// Set the request notifications and exit.
return pModuleInfo->SetRequestNotifications(
new MyHttpModuleFactory,
RQ_BEGIN_REQUEST,
0
);
}
El módulo debe exportar la función RegisterModule . Puede exportar esta función mediante la creación de un archivo de definición de módulo (.def) para el proyecto, o bien puede compilar el módulo mediante el /EXPORT:RegisterModule modificador . Para obtener más información, vea Tutorial: Creación de un módulo HTTP de Request-Level mediante código nativo.
Opcionalmente, puede compilar el código mediante la __stdcall (/Gz) convención de llamada en lugar de declarar explícitamente la convención de llamada para cada función.
Requisitos
| Tipo | Descripción |
|---|---|
| Remoto | - IIS 7.0 en Windows Vista - IIS 7.5 en Windows 7 - IIS 8.0 en Windows 8 - IIS 10.0 en Windows 10 |
| Servidor | - IIS 7.0 en Windows Server 2008 - IIS 7.5 en Windows Server 2008 R2 - IIS 8.0 en Windows Server 2012 - IIS 8.5 en Windows Server 2012 R2 - IIS 10.0 en Windows Server 2016 |
| Producto | - 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 |
| Encabezado | Httpserv.h |