ホーム › Networking.HttpServer › HttpSetServiceConfiguration

HttpSetServiceConfiguration

関数

HTTPサービスの構成設定を登録する。

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

シグネチャ

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

DWORD HttpSetServiceConfiguration(
    HANDLE ServiceHandle,   // optional
    HTTP_SERVICE_CONFIG_ID ConfigId,
    void* pConfigInformation,
    DWORD ConfigInformationLength,
    OVERLAPPED* pOverlapped   // optional
);

パラメーター

名前

型

方向

説明

ServiceHandle

HANDLE

optional

予約されています。ゼロでなければなりません。

ConfigId

HTTP_SERVICE_CONFIG_ID

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

ConfigId の値	意味
HttpServiceConfigIPListenList	IP リッスンリストにレコードを設定します。
HttpServiceConfigSSLCertInfo	指定した SSL 証明書レコードを設定します。
HttpServiceConfigUrlAclInfo	URL 予約レコードを設定します。
HttpServiceConfigTimeout	HTTP Server API 全体に適用される接続タイムアウトを設定します。 Windows Vista 以降: この列挙値はサポートされています。
HttpServiceConfigSslSniCertInfo	指定した SSL Server Name Indication (SNI) 証明書レコードを設定します。 Windows 8 以降: この列挙値はサポートされています。
HttpServiceConfigSslCcsCertInfo	ポートが Transport Layer Security (TLS) ハンドシェイクを受信したときに、証明書を検索するため Http.sys が Centralized Certificate Store (CCS) ストアを参照すべきであることを指定する SSL 証明書レコードを設定します。ポートは、pConfigInformation パラメーターに渡す HTTP_SERVICE_CONFIG_SSL_CCS_SET 構造体の KeyDesc メンバーで指定します。 Windows 8 以降: この列挙値はサポートされています。

pConfigInformation

void*

設定するレコードの種類に応じた適切なデータを格納するバッファーへのポインターです。

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 以降: この構造体はサポートされています。

ConfigInformationLength

DWORD

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

pOverlapped

OVERLAPPED*

optional

このパラメーターは予約されており、NULL でなければなりません。

戻り値の型: DWORD

公式ドキュメント

HTTP Server API の構成ストアに対する構成レコードを作成し、設定します。

戻り値

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

解説(Remarks)

HttpSetServiceConfiguration で設定した構成パラメーターは、マシン上のすべての 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 HttpSetServiceConfiguration(
    HANDLE ServiceHandle,   // optional
    HTTP_SERVICE_CONFIG_ID ConfigId,
    void* pConfigInformation,
    DWORD ConfigInformationLength,
    OVERLAPPED* pOverlapped   // optional
);

[DllImport("HTTPAPI.dll", ExactSpelling = true)]
static extern uint HttpSetServiceConfiguration(
    IntPtr ServiceHandle,   // HANDLE optional
    int ConfigId,   // HTTP_SERVICE_CONFIG_ID
    IntPtr pConfigInformation,   // void*
    uint ConfigInformationLength,   // DWORD
    IntPtr pOverlapped   // OVERLAPPED* optional
);

<DllImport("HTTPAPI.dll", ExactSpelling:=True)>
Public Shared Function HttpSetServiceConfiguration(
    ServiceHandle As IntPtr,   ' HANDLE optional
    ConfigId As Integer,   ' HTTP_SERVICE_CONFIG_ID
    pConfigInformation As IntPtr,   ' void*
    ConfigInformationLength As UInteger,   ' DWORD
    pOverlapped As IntPtr   ' OVERLAPPED* optional
) As UInteger
End Function

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

import ctypes
from ctypes import wintypes

HttpSetServiceConfiguration = ctypes.windll.httpapi.HttpSetServiceConfiguration
HttpSetServiceConfiguration.restype = wintypes.DWORD
HttpSetServiceConfiguration.argtypes = [
    wintypes.HANDLE,  # ServiceHandle : HANDLE optional
    ctypes.c_int,  # ConfigId : HTTP_SERVICE_CONFIG_ID
    ctypes.POINTER(None),  # pConfigInformation : void*
    wintypes.DWORD,  # ConfigInformationLength : DWORD
    ctypes.c_void_p,  # pOverlapped : OVERLAPPED* optional
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('HTTPAPI.dll')
HttpSetServiceConfiguration = Fiddle::Function.new(
  lib['HttpSetServiceConfiguration'],
  [
    Fiddle::TYPE_VOIDP,  # ServiceHandle : HANDLE optional
    Fiddle::TYPE_INT,  # ConfigId : HTTP_SERVICE_CONFIG_ID
    Fiddle::TYPE_VOIDP,  # pConfigInformation : void*
    -Fiddle::TYPE_INT,  # ConfigInformationLength : DWORD
    Fiddle::TYPE_VOIDP,  # pOverlapped : OVERLAPPED* optional
  ],
  -Fiddle::TYPE_INT)

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

$sig = @"
[DllImport("HTTPAPI.dll")]
public static extern uint HttpSetServiceConfiguration(IntPtr ServiceHandle, int ConfigId, IntPtr pConfigInformation, uint ConfigInformationLength, IntPtr pOverlapped);
"@
$api = Add-Type -MemberDefinition $sig -Name 'HTTPAPI_HttpSetServiceConfiguration' -Namespace Win32 -PassThru
# $api::HttpSetServiceConfiguration(ServiceHandle, ConfigId, pConfigInformation, ConfigInformationLength, pOverlapped)

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

出力引数:

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