Skip to content

ihttpserver-getworkerprocesssettings-method.md

Latest commit

 

History

History
57 lines (42 loc) · 4.14 KB

ihttpserver-getworkerprocesssettings-method.md

File metadata and controls

57 lines (42 loc) · 4.14 KB
title IHttpServer::GetWorkerProcessSettings Method
description Learn how the GetWorkerProcessSettings method retrieves an IWpfSettings interface.
ms.date 10/07/2016
ms.assetid 37efa150-d336-b2d7-77f8-872fb5887f7f

IHttpServer::GetWorkerProcessSettings Method

Retrieves an IWpfSettings interface.

Syntax

virtual HRESULT GetWorkerProcessSettings(  
   IWpfSettings** ppWorkerProcessSettings  
) = 0;

Parameters

ppWorkerProcessSettings
A dereferenced pointer to an IWpfSettings interface.

Return Value

An HRESULT. Possible values include, but are not limited to, those in the following table.

Value Description
S_OK Indicates that the operation was successful.

Remarks

The GetWorkerProcessSettings method allows developers to retrieve configuration information about the worker process framework through an IWpfSettings interface.

Note

The server controls the lifetime and reference counting for IWpfSettings.

IWpfSettings exposes several methods that you can use to retrieve specific information about the worker process framework. For example, the IWpfSettings::GetDwordProperty method enables you to retrieve the IDLE_TIMEOUT or PERIODIC_RESTART_TIME settings.

Example

The following code example illustrates how to use the GetWorkerProcessSettings method to create an HTTP module that retrieves the version of the common language runtime (CLR) on the server. The module then returns that information to a Web client.

[!code-cppIHttpServerGetWorkerProcessSettings#1]

Your module must export the RegisterModule function. You can export this function by creating a module definition (.def) file for your project, or you can compile the module by using the /EXPORT:RegisterModule switch. For more information, see Walkthrough: Creating a Request-Level HTTP Module By Using Native Code.

You can optionally compile the code by using the __stdcall (/Gz) calling convention instead of explicitly declaring the calling convention for each function.

Requirements

Type Description
Client - IIS 7.0 on [!INCLUDEwinvista]
- IIS 7.5 on Windows 7
- IIS 8.0 on Windows 8
- IIS 10.0 on Windows 10
Server - IIS 7.0 on [!INCLUDEwinsrv2008]
- IIS 7.5 on Windows Server 2008 R2
- IIS 8.0 on Windows Server 2012
- IIS 8.5 on Windows Server 2012 R2
- IIS 10.0 on Windows Server 2016
Product - IIS 7.0, IIS 7.5, IIS 8.0, IIS 8.5, IIS 10.0
- [!INCLUDEiisexp75], [!INCLUDEiisexp80], [!INCLUDEiisexp100]
Header Httpserv.h

See Also

IHttpServer Interface
IWpfSettings Interface