Share via

httpQueryRequestQueueProperty 函数 (http.h)

  • 项目

HttpQueryRequestQueueProperty 函数查询由指定句柄标识的请求队列的属性。

语法

HTTPAPI_LINKAGE ULONG HttpQueryRequestQueueProperty(
                  HANDLE               RequestQueueHandle,
  [in]            HTTP_SERVER_PROPERTY Property,
  [out]           PVOID                PropertyInformation,
  [in]            ULONG                PropertyInformationLength,
  [in]            ULONG                Reserved1,
  [out, optional] PULONG               ReturnLength,
  [in]            PVOID                Reserved2
);

parameters

RequestQueueHandle

[in] Property

描述所设置的属性类型的 HTTP_SERVER_PROPERTY 枚举的成员。 可以是以下位置之一：

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

[out] PropertyInformation

指向接收属性信息的缓冲区的指针。

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

属性 值
HttpServerStateProperty HTTP_ENABLED_STATE (枚举成员)
HttpServerQueueLengthProperty ULONG
HttpServer503VerbosityProperty HTTP_503_RESPONSE_VERBOSITY (枚举成员)

[in] PropertyInformationLength

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

[in] Reserved1

保留。 必须为零。

[out, optional] ReturnLength

pPropertyInformation 缓冲区中返回的数字（以字节为单位），如果不是 NULL。

如果输出缓冲区太小，调用将失败，返回值为 ERROR_MORE_DATA。 pReturnLength 指向的值可用于确定调用成功所需的最小缓冲区长度。

[in] Reserved2

此参数是保留的，必须为 NULL。

返回值

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

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

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

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

pPropertyInformation 参数为 NULL。

PropertyInformationLength 参数为零。

应用程序没有打开请求队列的权限。
ERROR_MORE_DATA
 pPropertyInformation 参数指向的缓冲区的大小（以字节为单位）太小，无法接收属性信息。 再次调用函数，缓冲区的大小至少与退出时 pReturnLength 指向的大小一样大。
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

HttpSetRequestQueueProperty

HttpShutdownRequestQueue