IHttpContext::GetServerVariable 方法
检索特定的服务器变量。
语法
virtual HRESULT GetServerVariable(
PCSTR pszVariableName,
PCWSTR * ppszValue,
DWORD * pcchValueLength
) = 0;
virtual HRESULT GetServerVariable(
PCSTR pszVariableName,
PCSTR * ppszValue,
DWORD * pcchValueLength
) = 0;
parameters
pszVariableName
指向包含要返回的服务器变量名称的字符串的指针。
ppszValue
指向接收服务器变量副本的字符串缓冲区的指针的地址。
pcchValueLengthr
指向接收参数长度的缓冲区的ppszValue
指针DWORD
。
返回值
HRESULT
。 可能的值包括(但并不限于)下表中的项。
值 | 说明 |
---|---|
S_OK | 指示操作成功。 |
ERROR_INVALID_INDEX | 指示 参数无效。 |
备注
方法 GetServerVariable
从当前 HTTP 上下文中检索由 pszVariableName
参数指定的服务器变量,并返回 参数指向 ppszValue
的缓冲区中的值。 参数 pszVariableName
指定的服务器变量可以是自定义变量,也可以是在请求注释 (RFC) 3875“通用网关接口 (CGI) 版本 1.1”中定义的变量。
注意
方法 GetServerVariable
支持通过重载方法返回 ANSI 和 Unicode 值。 参数指向的 ppszValue
缓冲区可以是 PCWSTR
或 PCSTR
缓冲区。
要求
类型 | 说明 |
---|---|
客户端 | - 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 |