HttpQueryUrlGroupProperty 関数 (http.h)

  • [アーティクル]

HttpQueryUrlGroupProperty 関数は、指定された URL グループのプロパティに対してクエリを実行します。

構文

HTTPAPI_LINKAGE ULONG HttpQueryUrlGroupProperty(
  [in]            HTTP_URL_GROUP_ID    UrlGroupId,
  [in]            HTTP_SERVER_PROPERTY Property,
  [out]           PVOID                PropertyInformation,
  [in]            ULONG                PropertyInformationLength,
  [out, optional] PULONG               ReturnLength
);

パラメーター

[in] UrlGroupId

プロパティ設定が返される URL グループの ID。

[in] Property

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

プロパティ 説明
HttpServerAuthenticationProperty
 有効なサーバー側認証スキームに対してクエリを実行します。
HttpServerTimeoutsProperty
 URL グループ接続のタイムアウト制限を照会します。
HttpServerStateProperty
 URL グループの現在の状態を照会します。 状態は、有効または無効にできます。
HttpServerQosProperty
 この値は、QosType が HttpQosSettingTypeBandwidth または HttpQosSettingTypeConnectionLimit に設定されたジェネリック HTTP_QOS_SETTING_INFO構造体にマップされます。 HttpQosSettingTypeBandwidth の場合は、URL グループの帯域幅調整を照会します。 HttpQosSettingTypeConnectionLimit の場合は、URL グループに対して提供される未処理の接続の最大数をいつでも照会します。
HttpServerChannelBindProperty
 チャネル バインド トークン (CBT) プロパティに対してクエリを実行します。

[out] PropertyInformation

プロパティ情報を受け取るバッファーへのポインター。

pPropertyInformation は、照会されるプロパティに基づいて、次のいずれかのプロパティ情報構造体を指します。

プロパティ 構造体
HttpServerStateProperty HTTP_STATE_INFO
HttpServerAuthenticationProperty HTTP_SERVER_AUTHENTICATION_INFO
HttpServerQosProperty HTTP_QOS_SETTING_INFO
HttpServerTimeoutsProperty HTTP_TIMEOUT_LIMIT_INFO
HttpServerChannelBindProperty HTTP_CHANNEL_BIND_INFO

[in] PropertyInformationLength

pPropertyInformation パラメーターが指すバッファーの長さ (バイト単位)。

[out, optional] ReturnLength

pPropertyInformation バッファーで返されるサイズ (バイト単位)。

出力バッファーが小さすぎる場合、呼び出しは ERROR_MORE_DATAの戻り値で失敗します。 pReturnLength が指す値を使用して、呼び出しが成功するために必要なバッファーの最小長を決定できます。

戻り値

関数が成功すると、 NO_ERRORが返されます。

関数が失敗した場合は、次のいずれかのエラー コードが返されます。

値 説明
ERROR_INVALID_PARAMETER
 Property パラメーターで指定された プロパティ の種類は、URL グループではサポートされていません。

UrlGroupId パラメーターは、有効なサーバー URL グループを識別しません。

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

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

アプリケーションには、URL グループのプロパティに対してクエリを実行するアクセス許可がありません。 URL グループを作成したアプリケーションのみがプロパティのクエリを実行できます。
ERROR_MORE_DATA
 pPropertyInformation パラメーターが指すバッファーのサイズ (バイト単位) が小さすぎてプロパティ情報を受信できません。 終了時に pReturnLength が指すサイズ以上のバッファーを使用して関数を再度呼び出します。

解説

HttpServerLoggingProperty のクエリはサポートされていません。

要件

   
サポートされている最小のクライアント Windows Vista [デスクトップ アプリのみ]
サポートされている最小のサーバー Windows Server 2008 [デスクトップ アプリのみ]
対象プラットフォーム Windows
ヘッダー http.h
Library Httpapi.lib
[DLL] Httpapi.dll

関連項目

HTTP Server API バージョン 2.0 関数

HttpAddUrlToUrlGroup

HttpCloseUrlGroup

HttpCreateUrlGroup

HttpRemoveUrlFromUrlGroup

HttpSetUrlGroupProperty