IHttpUser::IsInRole 方法
返回一个值,该值指示用户是否获得命名角色的授权。
语法
virtual HRESULT IsInRole(
IN PCWSTR pszRoleName,
OUT BOOL* pfInRole
) = 0;
parameters
pszRoleName
[IN]指向常量以 null 结尾的 Unicode 字符串的指针,该字符串包含角色的名称。
pfInRole
[OUT]指向 BOOL
的指针,指示用户是否获得由 指定的角色的 pszRoleName
授权。
返回值
HRESULT
。 可能的值包括(但并不限于)下表中的项。
值 | 定义 |
---|---|
S_OK | 指示操作成功。 |
E_NOTIMPL | 指示 IsInRole 未实现方法。 |
备注
IsInRole
仅当 SupportsIsInRole 方法首次在同一 IHttpUser 指针上返回true
时,才调用 方法。
返回 IsInRole
值取决于实现。 应将以下信息用作指南,但并非所有情况都正确:
IHttpUser
如果实现者处理匿名身份验证,则仅当参数为 NULL 或为空时pszRoleName
,取消引用pfInRole
参数才会设置为true
。IsInRole
然后始终返回S_OK。IHttpUser
如果实施者处理基本、认证映射、SSPI 或自定义身份验证,则pfInRole
参数未修改,并IsInRole
立即返回E_NOTIMPL。IHttpUser
如果实施者处理托管身份验证,则pfInRole
参数未修改,如果IsInRole
任一参数为 NULL,则立即返回E_INVALIDARG。 否则,pfInRole
设置为true
,并且IsInRole
仅当用户处于角色中时才返回S_OK。
示例
下面的代码示例演示如何创建一个 HTTP 模块,该模块清除响应标头和正文,然后将用户信息作为 XML 文档返回给客户端。
上述代码将类似于以下内容的 XML 写入响应流。
<?xml version="1.0" ?>
<user supportsRoles="true" isInRole="false" />
模块必须导出 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 |