httpSetServerSessionProperty 函数 (http.h)

  • 项目

HttpSetServerSessionProperty 函数设置新的服务器会话属性或修改指定服务器会话上的现有属性。

语法

HTTPAPI_LINKAGE ULONG HttpSetServerSessionProperty(
  [in] HTTP_SERVER_SESSION_ID ServerSessionId,
  [in] HTTP_SERVER_PROPERTY   Property,
  [in] PVOID                  PropertyInformation,
  [in] ULONG                  PropertyInformationLength
);

参数

[in] ServerSessionId

为其设置了 属性的服务器会话。

[in] Property

描述所设置的属性类型的 HTTP_SERVER_PROPERTY 枚举的成员。 这可以是以下其中一种。

属性 含义
HttpServerStateProperty
 修改或设置服务器会话的状态。 状态可以是启用或禁用的;默认状态已启用。
HttpServerTimeoutsProperty
 修改或设置服务器会话连接超时限制。
HttpServerQosProperty
 修改或设置服务器会话的带宽限制。 默认情况下，HTTP 服务器 API 不限制带宽。
注意此值映射到 QosType 设置为 HttpQosSettingTypeBandwidth 的泛型HTTP_QOS_SETTING_INFO结构。
 
HttpServerLoggingProperty
 启用或禁用服务器会话的日志记录。 此属性仅设置集中式 W3C 和集中式二进制日志记录。 默认情况下，不启用日志记录。
HttpServerAuthenticationProperty
 为基本、NTLM、协商和摘要式身份验证方案启用内核模式服务器端身份验证。
HttpServerExtendedAuthenticationProperty
 为 Kerberos 身份验证方案启用内核模式服务器端身份验证。
HttpServerChannelBindProperty
启用使用通道绑定令牌 (CBT) 的服务器端身份验证。

[in] PropertyInformation

指向包含属性数据的缓冲区的指针。

pPropertyInformation 基于设置的属性指向下表中列出的属性数据结构。

属性 结构
HttpServerStateProperty HTTP_STATE_INFO
HttpServerLoggingProperty HTTP_LOGGING_INFO
HttpServerQosProperty HTTP_QOS_SETTING_INFO
HttpServerTimeoutsProperty HTTP_TIMEOUT_LIMIT_INFO
HttpServerAuthenticationProperty HTTP_SERVER_AUTHENTICATION_INFO
HttpServerExtendedAuthenticationProperty HTTP_SERVER_AUTHENTICATION_INFO
HttpServerChannelBindProperty HTTP_CHANNEL_BIND_INFO

[in] PropertyInformationLength

pPropertyInformation 参数指向的缓冲区的长度（以字节为单位）。

返回值

如果函数成功，则返回 NO_ERROR

如果该函数失败，它将返回以下错误代码之一。

值 含义
ERROR_INVALID_PARAMETER
 服务器会话不支持 Property 参数中指定的属性类型。

pPropertyInformation 参数为 NULL。

PropertyInformationLength 参数为零。

ServerSessionId 参数不包含有效的服务器会话。

应用程序无权设置服务器会话属性。 只有创建服务器会话的应用程序才能设置属性。

注解

服务器会话是用于配置数据的顶级配置容器，适用于在它们下创建的所有 URL 组。 服务器会话是使用 HttpCreateServerSession 创建的。

pPropertyInformation 参数指向所设置的属性类型的配置结构。 PropertyInformationLength 参数指定配置结构的大小（以字节为单位）。 例如，在设置 HttpServerTimeoutsProperty 时， pPropertyInformation 参数必须指向至少等于 HTTP_TIMEOUT_LIMIT_INFO 结构大小的缓冲区。

要求

要求 值
最低受支持的客户端 Windows Vista [仅限桌面应用]
最低受支持的服务器 Windows Server 2008 [仅限桌面应用]
目标平台 Windows
标头 http.h
Library Httpapi.lib
DLL Httpapi.dll

另请参阅

HTTP 服务器 API 版本 2.0 函数

HttpCloseServerSession

HttpCreateServerSession

HttpQueryServerSessionProperty

HttpSetServerSessionProperty