Edit

IHttpUser::GetUserVariable Method

  • Article

Returns the custom user data by name.

Syntax

virtual PVOID GetUserVariable(  
   IN PCSTR pszVariableName  
) = 0;

Parameters

pszVariableName
[IN] A pointer to a constant null-terminated string that contains the variable name of the data to retrieve.

Return Value

A void pointer that contains the upcast custom data.

Remarks

The default is HTTP_USER_VARIABLE_SID, which is defined in the Httpserv.h header file.

Notes for Implementers

IHttpUser implementers are responsible for memory management with this data; therefore, IHttpUser implementers that use dynamic memory allocation must release or delete the void pointer when it is no longer needed.

Notes for Callers

IHttpUser implementers are responsible for memory management with this data; therefore, IHttpUser clients must not release or delete the returned void pointer when this data is no longer needed. Furthermore, clients must not change the state of the memory referenced by this void pointer, because an access violation will be thrown or the data will become invalid.

Example

The following code example demonstrates how to create an HTTP module that clears the response headers and body and then returns user information to the client as an XML document.

The above code writes XML that is similar to the following to the response stream.

<?xml version="1.0" ?>  
<user userName="DOMAIN\user" />

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

See Also

IHttpUser Interface