IHttpContext::SetServerVariable Method

IIS 7.0
 

Sets a server variable to a specified value.

virtual HRESULT SetServerVariable(
   PCSTR pszVariableName,
   PCWSTR pszVariableValue
) = 0;

pszVariableName

[IN] A pointer to a string that contains the name of the server variable to set.

pszVariableValue

[IN] A pointer to a string that contains the value of the server variable to set.

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.

ERROR_NOT_ENOUGH_MEMORY

Indicates that there is insufficient memory to perform the operation.

The SetServerVariable method specifies the values for Common Gateway Interface (CGI) server variables. The server variable specified by the pszVariableName parameter can be a custom variable or a variable defined in Request for Comments (RFC) 3875, "The Common Gateway Interface (CGI) Version 1.1."

System_CAPS_noteNote

The server variable specified by the pszVariableName parameter is created if it does not exist.

Example

The following code example demonstrates how to use the SetServerVariable method to create an HTTP module that sets the value of the SERVER_NAME server variable to an example value.

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 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 Windows Vista

  • IIS 7.5 on Windows 7

  • IIS 8.0 on Windows 8

  • IIS 10.0 on Windows 10

Server

  • IIS 7.0 on Windows Server 2008

  • 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 Technical Preview

Product

  • 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

Show: