httpSetRequestQueueProperty 函数 (http.h)

  • 项目

HttpSetRequestQueueProperty 函数设置由指定句柄标识的请求队列上的新属性或修改现有属性。

语法

HTTPAPI_LINKAGE ULONG HttpSetRequestQueueProperty(
  [in] HANDLE               RequestQueueHandle,
  [in] HTTP_SERVER_PROPERTY Property,
  [in] PVOID                PropertyInformation,
  [in] ULONG                PropertyInformationLength,
  [in] ULONG                Reserved1,
  [in] PVOID                Reserved2
);

参数

[in] RequestQueueHandle

设置属性的请求队列的句柄。 创建请求队列，并通过调用 HttpCreateRequestQueue 函数返回其句柄。

[in] Property

描述所设置的属性类型的 HTTP_SERVER_PROPERTY 枚举的成员。 这必须是下列项之一：

属性 含义
HttpServer503VerbosityProperty
 修改或设置为请求队列生成的 503 响应的当前详细级别。
HttpServerQueueLengthProperty
 修改或设置对请求队列中未完成的请求数的限制。
HttpServerStateProperty
 修改或设置请求队列的状态。 状态必须为活动或非活动状态。

[in] PropertyInformation

指向包含属性信息的缓冲区的指针。

pPropertyInformation 根据设置的属性指向以下属性信息类型之一。

属性 配置类型
HttpServerStateProperty HTTP_ENABLED_STATE 枚举
HttpServerQueueLengthProperty ULONG
HttpServer503VerbosityProperty HTTP_503_RESPONSE_VERBOSITY 枚举

[in] PropertyInformationLength

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

[in] Reserved1

保留。 必须为零。

[in] Reserved2

保留。 必须为 NULL。

返回值

如果函数成功，则返回 NO_ERROR。

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

值 含义
ERROR_INVALID_PARAMETER
 保留参数不为零或 pReserved 参数不为 NULL。

请求队列不支持 Property 参数中指定的属性类型。

pPropertyInformation 参数为 NULL。

PropertyInformationLength 参数为零。

应用程序无权设置请求队列的属性。 只有创建请求队列的应用程序才能设置属性。
ERROR_NOT_SUPPORTED
 请求队列的句柄是 HTTP 版本 1.0 句柄。 只有 HTTP 版本 2.0 或更高版本的请求队列支持属性管理。

要求

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

另请参阅

HTTP 服务器 API 版本 2.0 函数

HttpCloseRequestQueue

HttpCreateRequestQueue

HttpQueryRequestQueueProperty

HttpShutdownRequestQueue