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

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

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

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

アプリケーションには、要求キューにプロパティを設定するアクセス許可がありません。 要求キューを作成したアプリケーションのみがプロパティを設定できます。
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

HttpQueryRequestQueueProperty

HttpShutdownRequestQueue