HttpSetServerSessionProperty 関数 (http.h)

  • [アーティクル]

HttpSetServerSessionProperty 関数は、新しいサーバー セッション プロパティを設定するか、指定されたサーバー セッションの既存のプロパティを変更します。

構文

HTTPAPI_LINKAGE ULONG HttpSetServerSessionProperty(
  [in] HTTP_SERVER_SESSION_ID ServerSessionId,
  [in] HTTP_SERVER_PROPERTY   Property,
  [in] PVOID                  PropertyInformation,
  [in] ULONG                  PropertyInformationLength
);

パラメーター

[in] ServerSessionId

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

[in] Property

設定されたプロパティ型を記述する HTTP_SERVER_PROPERTY 列挙体のメンバー。 これは、次のいずれかになります。

プロパティ 意味
HttpServerStateProperty
 サーバー セッションの状態を変更または設定します。 状態は有効または無効にできます。既定の状態が有効になっています。
HttpServerTimeoutsProperty
 サーバー セッション接続のタイムアウト制限を変更または設定します。
HttpServerQosProperty
 サーバー セッションの帯域幅調整を変更または設定します。 既定では、HTTP Server API は帯域幅を制限しません。
メモこの値は、QosType が HttpQosSettingTypeBandwidth に設定された汎用HTTP_QOS_SETTING_INFO構造体にマップされます。
 
HttpServerLoggingProperty
 サーバー セッションのログ記録を有効または無効にします。 このプロパティは、一元化された W3C と一元化されたバイナリ ログのみを設定します。 既定では、ログ記録は有効になっていません。
HttpServerAuthenticationProperty
 基本、NTLM、ネゴシエート、ダイジェスト認証スキームのカーネル モード サーバー側認証を有効にします。
HttpServerExtendedAuthenticationProperty
 Kerberos 認証スキームのカーネル モード サーバー側認証を有効にします。
HttpServerChannelBindProperty
チャネル バインド トークン (CBT) を使用するサーバー側認証を有効にします。

[in] PropertyInformation

プロパティ データを含むバッファーへのポインター。

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

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

[in] PropertyInformationLength

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

戻り値

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

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

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

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

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

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

アプリケーションには、サーバー セッションのプロパティを設定するアクセス許可がありません。 プロパティを設定できるのは、サーバー セッションを作成したアプリケーションだけです。

注釈

サーバー セッションは、その下に作成されたすべての URL グループに適用される構成データの最上位の構成コンテナーです。 サーバー セッションは HttpCreateServerSession を使用して作成されます。

pPropertyInformation パラメーターは、設定されたプロパティ型の構成構造を指します。 PropertyInformationLength パラメーターは、構成構造のサイズをバイト単位で指定します。 たとえば、 HttpServerTimeoutsProperty を設定する場合、 pPropertyInformation パラメーターは 、HTTP_TIMEOUT_LIMIT_INFO 構造体のサイズ以上のバッファーを指す必要があります。

要件

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

こちらもご覧ください

HTTP Server API バージョン 2.0 関数

HttpCloseServerSession

HttpCreateServerSession

HttpQueryServerSessionProperty

HttpSetServerSessionProperty