HttpSetServiceConfiguration 関数 (http.h)

  • [アーティクル]

HttpSetServiceConfiguration 関数は、HTTP Server API 構成ストアの構成レコードを作成して設定します。 指定したレコードが既に存在する場合、呼び出しは失敗します。 特定の構成レコードを変更するには、そのレコードを削除してから、別の値で再作成します。

構文

HTTPAPI_LINKAGE ULONG HttpSetServiceConfiguration(
  [in] HANDLE                 ServiceHandle,
  [in] HTTP_SERVICE_CONFIG_ID ConfigId,
  [in] PVOID                  pConfigInformation,
  [in] ULONG                  ConfigInformationLength,
  [in] LPOVERLAPPED           pOverlapped
);

パラメーター

[in] ServiceHandle

予約済み。 ゼロを指定してください。

[in] ConfigId

設定する構成レコードの種類。 このパラメーターには、 HTTP_SERVICE_CONFIG_ID 列挙の次のいずれかの値を指定できます。

ConfigId 値 意味
HttpServiceConfigIPListenList
 IP リッスン リストのレコードを設定します。
HttpServiceConfigSSLCertInfo
 指定した SSL 証明書レコードを設定します。
HttpServiceConfigUrlAclInfo
 URL 予約レコードを設定します。
HttpServiceConfigTimeout
 指定した HTTP Server API ワイド接続タイムアウトを設定します。

Windows Vista 以降: この列挙値はサポートされています。
HttpServiceConfigSslSniCertInfo
 指定した SSL サーバー名表示 (SNI) 証明書レコードを設定します。

Windows 8 以降: この列挙値がサポートされています。
HttpServiceConfigSslCcsCertInfo
 ポートがトランスポート層セキュリティ (TLS) ハンドシェイクを受け取った場合に、Http.sys が一元化された証明書ストア (CCS) ストアを参照して証明書を検索するように指定する SSL 証明書レコードを設定します。 ポートは、pConfigInformation パラメーターに渡すHTTP_SERVICE_CONFIG_SSL_CCS_SET構造体の KeyDesc メンバーによって指定されます。

Windows 8 以降: この列挙値がサポートされています。

[in] pConfigInformation

設定するレコードの種類を指定するための適切なデータを含むバッファーへのポインター。

ConfigId 値 意味
HttpServiceConfigIPListenList

HTTP_SERVICE_CONFIG_IP_LISTEN_PARAM 構造体。
HttpServiceConfigSSLCertInfo

HTTP_SERVICE_CONFIG_SSL_SET 構造体。
HttpServiceConfigUrlAclInfo

HTTP_SERVICE_CONFIG_URLACL_SET 構造体。
HttpServiceConfigTimeout

HTTP_SERVICE_CONFIG_TIMEOUT_SET 構造体。

Windows Vista 以降: この構造体はサポートされています。
HttpServiceConfigSslSniCertInfo

HTTP_SERVICE_CONFIG_SSL_SNI_SET 構造体。 ホスト名は、SSL 中央証明書ストアに対してクエリが実行され、ワイルドカード バインドが使用され、通常の SNI のホスト名が "*" になります。

Windows 8 以降: この構造体はサポートされています。
HttpServiceConfigSslCcsCertInfo

HTTP_SERVICE_CONFIG_SSL_CCS_SET 構造体。

Windows 8 以降: この構造体はサポートされています。

[in] ConfigInformationLength

pConfigInformation バッファーのサイズ (バイト単位)。

[in] pOverlapped

このパラメーターは予約済みであり、 NULL である必要があります。

戻り値

関数が成功した場合、戻り値は NO_ERROR。

関数が失敗した場合、戻り値は次のいずれかのエラー コードになります。

値 意味
ERROR_ALREADY_EXISTS
 指定されたレコードは既に存在し、その値を再設定するには削除する必要があります。
ERROR_INSUFFICIENT_BUFFER
 ConfigInformationLength パラメーターで指定されたバッファー サイズが不十分です。
ERROR_INVALID_HANDLE
 ServiceHandle パラメーターが無効です。
ERROR_INVALID_PARAMETER
 指定されたパラメーターの 1 つ以上が使用できない形式です。
ERROR_NO_SUCH_LOGON_SESSION
 使用されている SSL 証明書が無効です。 これは、 HttpServiceConfigSSLCertInfo パラメーターが使用されている場合にのみ発生します。
その他
 WinError.h で定義されている システム エラー コード 。

注釈

HttpSetServiceConfiguration で設定された構成パラメーターは、コンピューター上のすべての HTTP Server API アプリケーションに適用され、HTTP Server API がシャットダウンされたとき、またはコンピューターが再起動されたときに保持されます。

要件

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

こちらもご覧ください

HTTP Server API バージョン 1.0 関数

HttpDeleteServiceConfiguration

HttpQueryServiceConfiguration

HttpUpdateServiceConfiguration