ホーム › Networking.HttpServer › HttpUpdateServiceConfiguration

HttpUpdateServiceConfiguration

関数

HTTPサービスの構成設定を更新する。

DLLHTTPAPI.dll呼出規約winapi対応OSWindows 10 以降

シグネチャ

// HTTPAPI.dll
#include <windows.h>

DWORD HttpUpdateServiceConfiguration(
    HANDLE Handle,   // optional
    HTTP_SERVICE_CONFIG_ID ConfigId,
    void* ConfigInfo,
    DWORD ConfigInfoLength,
    OVERLAPPED* Overlapped   // optional
);

パラメーター

名前

型

方向

説明

Handle

HANDLE

optional

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

ConfigId

HTTP_SERVICE_CONFIG_ID

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

ConfigId の値	意味
HttpServiceConfigSSLCertInfo	指定された SSL 証明書レコードを更新します。
HttpServiceConfigSslSniCertInfo	指定された SSL Server Name Indication (SNI) 証明書レコードを更新します。
HttpServiceConfigSslCcsCertInfo	ポートが TLS ハンドシェイクを受信した場合に、Http.sys が証明書を見つけるために集中証明書ストア (CCS) を参照すべきことを指定する SSL 証明書レコードを更新します。ポートは、pConfigInfo パラメーターに渡す HTTP_SERVICE_CONFIG_SSL_CCS_SET 構造体の KeyDesc メンバーで指定します。

ConfigInfo

void*

更新するレコードの種類を指定する適切なデータを格納したバッファーへのポインター。次の表は、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 レコードの削除、取得、または更新に使用されます。

ConfigInfoLength

DWORD

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

Overlapped

OVERLAPPED*

optional

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

戻り値の型: DWORD

公式ドキュメント

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

戻り値

関数が成功した場合、戻り値は 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 で定義されているシステムエラーコード。

解説(Remarks)

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

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// HTTPAPI.dll
#include <windows.h>

DWORD HttpUpdateServiceConfiguration(
    HANDLE Handle,   // optional
    HTTP_SERVICE_CONFIG_ID ConfigId,
    void* ConfigInfo,
    DWORD ConfigInfoLength,
    OVERLAPPED* Overlapped   // optional
);

[DllImport("HTTPAPI.dll", ExactSpelling = true)]
static extern uint HttpUpdateServiceConfiguration(
    IntPtr Handle,   // HANDLE optional
    int ConfigId,   // HTTP_SERVICE_CONFIG_ID
    IntPtr ConfigInfo,   // void*
    uint ConfigInfoLength,   // DWORD
    IntPtr Overlapped   // OVERLAPPED* optional
);

<DllImport("HTTPAPI.dll", ExactSpelling:=True)>
Public Shared Function HttpUpdateServiceConfiguration(
    Handle As IntPtr,   ' HANDLE optional
    ConfigId As Integer,   ' HTTP_SERVICE_CONFIG_ID
    ConfigInfo As IntPtr,   ' void*
    ConfigInfoLength As UInteger,   ' DWORD
    Overlapped As IntPtr   ' OVERLAPPED* optional
) As UInteger
End Function

' Handle : HANDLE optional
' ConfigId : HTTP_SERVICE_CONFIG_ID
' ConfigInfo : void*
' ConfigInfoLength : DWORD
' Overlapped : OVERLAPPED* optional
Declare PtrSafe Function HttpUpdateServiceConfiguration Lib "httpapi" ( _
    ByVal Handle As LongPtr, _
    ByVal ConfigId As Long, _
    ByVal ConfigInfo As LongPtr, _
    ByVal ConfigInfoLength As Long, _
    ByVal Overlapped As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

HttpUpdateServiceConfiguration = ctypes.windll.httpapi.HttpUpdateServiceConfiguration
HttpUpdateServiceConfiguration.restype = wintypes.DWORD
HttpUpdateServiceConfiguration.argtypes = [
    wintypes.HANDLE,  # Handle : HANDLE optional
    ctypes.c_int,  # ConfigId : HTTP_SERVICE_CONFIG_ID
    ctypes.POINTER(None),  # ConfigInfo : void*
    wintypes.DWORD,  # ConfigInfoLength : DWORD
    ctypes.c_void_p,  # Overlapped : OVERLAPPED* optional
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('HTTPAPI.dll')
HttpUpdateServiceConfiguration = Fiddle::Function.new(
  lib['HttpUpdateServiceConfiguration'],
  [
    Fiddle::TYPE_VOIDP,  # Handle : HANDLE optional
    Fiddle::TYPE_INT,  # ConfigId : HTTP_SERVICE_CONFIG_ID
    Fiddle::TYPE_VOIDP,  # ConfigInfo : void*
    -Fiddle::TYPE_INT,  # ConfigInfoLength : DWORD
    Fiddle::TYPE_VOIDP,  # Overlapped : OVERLAPPED* optional
  ],
  -Fiddle::TYPE_INT)

#[link(name = "httpapi")]
extern "system" {
    fn HttpUpdateServiceConfiguration(
        Handle: *mut core::ffi::c_void,  // HANDLE optional
        ConfigId: i32,  // HTTP_SERVICE_CONFIG_ID
        ConfigInfo: *mut (),  // void*
        ConfigInfoLength: u32,  // DWORD
        Overlapped: *mut OVERLAPPED  // OVERLAPPED* optional
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("HTTPAPI.dll")]
public static extern uint HttpUpdateServiceConfiguration(IntPtr Handle, int ConfigId, IntPtr ConfigInfo, uint ConfigInfoLength, IntPtr Overlapped);
"@
$api = Add-Type -MemberDefinition $sig -Name 'HTTPAPI_HttpUpdateServiceConfiguration' -Namespace Win32 -PassThru
# $api::HttpUpdateServiceConfiguration(Handle, ConfigId, ConfigInfo, ConfigInfoLength, Overlapped)

#uselib "HTTPAPI.dll"
#func global HttpUpdateServiceConfiguration "HttpUpdateServiceConfiguration" sptr, sptr, sptr, sptr, sptr
; HttpUpdateServiceConfiguration Handle, ConfigId, ConfigInfo, ConfigInfoLength, varptr(Overlapped)   ; 戻り値は stat
; Handle : HANDLE optional -> "sptr"
; ConfigId : HTTP_SERVICE_CONFIG_ID -> "sptr"
; ConfigInfo : void* -> "sptr"
; ConfigInfoLength : DWORD -> "sptr"
; Overlapped : OVERLAPPED* optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "HTTPAPI.dll"
#cfunc global HttpUpdateServiceConfiguration "HttpUpdateServiceConfiguration" sptr, int, sptr, int, var
; res = HttpUpdateServiceConfiguration(Handle, ConfigId, ConfigInfo, ConfigInfoLength, Overlapped)
; Handle : HANDLE optional -> "sptr"
; ConfigId : HTTP_SERVICE_CONFIG_ID -> "int"
; ConfigInfo : void* -> "sptr"
; ConfigInfoLength : DWORD -> "int"
; Overlapped : OVERLAPPED* optional -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "HTTPAPI.dll"
#cfunc global HttpUpdateServiceConfiguration "HttpUpdateServiceConfiguration" sptr, int, sptr, int, sptr
; res = HttpUpdateServiceConfiguration(Handle, ConfigId, ConfigInfo, ConfigInfoLength, varptr(Overlapped))
; Handle : HANDLE optional -> "sptr"
; ConfigId : HTTP_SERVICE_CONFIG_ID -> "int"
; ConfigInfo : void* -> "sptr"
; ConfigInfoLength : DWORD -> "int"
; Overlapped : OVERLAPPED* optional -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。