IHttpUser::GetUserVariable 方法

按名称返回自定义用户数据。

语法

virtual PVOID GetUserVariable(  
   IN PCSTR pszVariableName  
) = 0;  

parameters

pszVariableName
[IN]指向以 null 结尾的常量字符串的指针,该字符串包含要检索的数据的变量名称。

返回值

包含 void 向上转换自定义数据的指针。

备注

默认值为 HTTP_USER_VARIABLE_SID,这是在 Httpserv.h 头文件中定义的。

实现者须知

IHttpUser 实现者负责使用此数据进行内存管理;因此,IHttpUser使用动态内存分配的实现程序必须在不再需要该分配或deletevoid指针时释放它。

对调用者的说明

IHttpUser 实施者负责使用此数据进行内存管理;因此,当不再需要此数据时, IHttpUser 客户端不得释放或 delete 返回的 void 指针。 此外,客户端不得更改此 void 指针引用的内存的状态,因为将引发访问冲突或数据将变为无效。

示例

下面的代码示例演示如何创建一个 HTTP 模块,该模块清除响应标头和正文,然后将用户信息作为 XML 文档返回给客户端。

上述代码将类似于以下内容的 XML 写入响应流。

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

模块必须导出 RegisterModule 函数。 可以通过为项目创建模块定义 (.def) 文件导出此函数,也可以使用 开关编译模块 /EXPORT:RegisterModule 。 有关详细信息,请参阅 演练:使用本机代码创建Request-Level HTTP 模块

可以选择使用调用约定编译代码, __stdcall (/Gz) 而不是为每个函数显式声明调用约定。

要求

类型 说明
客户端 - Windows Vista 上的 IIS 7.0
- Windows 7 上的 IIS 7.5
- Windows 8 上的 IIS 8.0
- Windows 10 上的 IIS 10.0
服务器 - Windows Server 2008 上的 IIS 7.0
- Windows Server 2008 R2 上的 IIS 7.5
- Windows Server 2012 上的 IIS 8.0
- Windows Server 2012 R2 上的 IIS 8.5
- Windows Server 2016 上的 IIS 10.0
产品 - 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

另请参阅

IHttpUser 接口