HttpQueryServerSessionProperty 関数 (http.h)

  • [アーティクル]

HttpQueryServerSessionProperty 関数は、指定されたサーバー セッションのサーバー プロパティに対してクエリを実行します。

構文

HTTPAPI_LINKAGE ULONG HttpQueryServerSessionProperty(
  [in]            HTTP_SERVER_SESSION_ID ServerSessionId,
  [in]            HTTP_SERVER_PROPERTY   Property,
  [out]           PVOID                  PropertyInformation,
  [in]            ULONG                  PropertyInformationLength,
  [out, optional] PULONG                 ReturnLength
);

パラメーター

[in] ServerSessionId

プロパティ設定が返されるサーバー セッション。

[in] Property

クエリを実行するプロパティの種類を記述する HTTP_SERVER_PROPERTY 列挙体のメンバー。 これは、次のいずれかになります。

プロパティ 意味
HttpServerStateProperty
 サーバー セッションの現在の状態を照会します。
HttpServerTimeoutsProperty
 サーバー セッション接続のタイムアウト制限に対してクエリを実行します。
HttpServerQosProperty
 サーバー セッションの帯域幅調整を照会します。 既定では、HTTP Server API は帯域幅を制限しません。
HttpServerAuthenticationProperty
 基本、NTLM、ネゴシエート、ダイジェスト認証スキームのカーネル モード サーバー側認証に対してクエリを実行します。
HttpServerChannelBindProperty
 チャネル バインド トークン (CBT) プロパティに対してクエリを実行します。

[out] PropertyInformation

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

pPropertyInformation は、設定された プロパティに基づいて、次のいずれかのプロパティ データ構造を指します。

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

[in] PropertyInformationLength

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

[out, optional] ReturnLength

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

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

戻り値

関数が成功した場合は、NO_ERRORを返します

関数が失敗すると、次のいずれかのエラー コードが返されます。

値 意味
ERROR_INVALID_PARAMETER
 Property パラメーターで指定された プロパティ の種類は、サーバー セッションではサポートされていません。

ServerSessionId パラメーターに、有効なサーバー セッションが含まれていません。

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

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

アプリケーションには、サーバー セッションのプロパティに対してクエリを実行する権限がありません。 サーバー セッションを作成したアプリケーションのみがプロパティに対してクエリを実行できます。
ERROR_MORE_DATA
 pPropertyInformation パラメーターが指すバッファーのサイズ (バイト単位) が小さすぎてプロパティ データを受信できません。 終了時に、少なくとも終了時に pReturnLength が指すサイズと同じ大きさのバッファーを使用して、関数を再度呼び出します。

注釈

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

pPropertyInformation パラメーターは、照会されるプロパティ型の構成構造を指します。 PropertyInformationLength パラメーターは、構成構造のサイズをバイト単位で指定します。 たとえば、 HttpServerTimeoutsProperty に対してクエリを実行する場合、 pPropertyInformation パラメーターは 、少なくとも HTTP_TIMEOUT_LIMIT_INFO 構造体のサイズであるバッファーを指している必要があります。

pPropertyInformation パラメーターで HttpServerQosProperty プロパティを指定するには、HTTP_QOS_SETTING_INFO構造体内で QosType を HttpQosSettingTypeBandwidth に設定し、 パラメーターでこの構造体へのポインターを渡します。

要件

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

こちらもご覧ください

HTTP Server API バージョン 2.0 関数

HttpCloseServerSession

HttpCreateServerSession

HttpQueryServerSessionProperty

HttpSetServerSessionProperty