HttpUpdateServiceConfiguration 関数 (http.h)

[アーティクル]
02/29/2024

更新 HTTP Server API 構成ストア内の構成レコード内のトランスポート層セキュリティ (TLS) 証明書を指定するサービス構成パラメーターをアトミックに指定します。

構文

HTTPAPI_LINKAGE ULONG HttpUpdateServiceConfiguration(
  [in] HANDLE                 Handle,
  [in] HTTP_SERVICE_CONFIG_ID ConfigId,
  [in] PVOID                  ConfigInfo,
  [in] ULONG                  ConfigInfoLength,
  [in] LPOVERLAPPED           Overlapped
);

パラメーター

[in] Handle

予約済みで、 NULL である必要があります。

[in] ConfigId

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

ConfigId 値	意味
HttpServiceConfigSSLCertInfo	指定した SSL 証明書レコードを更新します。
HttpServiceConfigSslSniCertInfo	指定した SSL サーバー名表示 (SNI) 証明書レコードを更新します。
HttpServiceConfigSslCcsCertInfo	ポートが TLS ハンドシェイクを受け取った場合、Http.sys が一元化された証明書ストア (CCS) ストアを参照して証明書を検索する必要があることを指定する SSL 証明書レコードを更新します。ポートは、pConfigInfo パラメーターに渡すHTTP_SERVICE_CONFIG_SSL_CCS_SET構造体の KeyDesc メンバーによって指定されます。

[in] ConfigInfo

更新するレコードの種類を指定するための適切なデータを含むバッファーへのポインター。次の表は、 ConfigId パラメーターのさまざまな値に対してバッファーに含まれるデータの種類を示しています。

ConfigId 値	pConfigInfo バッファー内のデータの種類
HttpServiceConfigSSLCertInfo	HTTP_SERVICE_CONFIG_SSL_SET 構造体。
HttpServiceConfigSslSniCertInfo	HTTP_SERVICE_CONFIG_SSL_SNI_SET 構造体。ホスト名は、SSL 中央証明書ストアに対してクエリが実行され、ワイルドカードバインドが使用され、通常の SNI のホスト名が "*" になります。
HttpServiceConfigSslCcsCertInfo	HTTP_SERVICE_CONFIG_SSL_CCS_SET 構造体。この構造体は、指定したポートに CCS ストアを追加したり、既存の SSL CCS レコードを削除、取得、または更新したりするために使用されます。

[in] ConfigInfoLength

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

[in] Overlapped

予約済みで、 NULL である必要があります。

戻り値

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

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

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

注釈

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

要件

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