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
);

パラメーター

RequestQueueHandle

[in] Property

設定されたプロパティの種類を記述する HTTP_SERVER_PROPERTY 列挙体のメンバー。 DLL は、次のいずれかの場所に置くことができます。

プロパティ 説明
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
 予約済みパラメーターが 0 ではないか、pReserved パラメーターが NULL ではありません。

Property パラメーターで指定された プロパティ の種類は、要求キューではサポートされていません。

pPropertyInformation パラメーターは NULL です。

PropertyInformationLength パラメーターは 0 です。

アプリケーションには、要求キューを開くアクセス許可がありません。
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 Server API バージョン 2.0 関数

HttpCloseRequestQueue

HttpCreateRequestQueue

HttpSetRequestQueueProperty

HttpShutdownRequestQueue