ホーム › Networking.WinSock › WSCUpdateProvider

WSCUpdateProvider

関数

登録済みプロバイダーの構成情報を更新する。

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

シグネチャ

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

INT WSCUpdateProvider(
    GUID* lpProviderId,
    LPCWSTR lpszProviderDllPath,
    const WSAPROTOCOL_INFOW* lpProtocolInfoList,
    DWORD dwNumberOfEntries,
    INT* lpErrno
);

パラメーター

名前	型	方向	説明
lpProviderId	GUID*	in	プロバイダーのグローバル一意識別子 (GUID) へのポインター。
lpszProviderDllPath	LPCWSTR	in	プロバイダーの 64 ビット DLL へのロードパスを含む Unicode 文字列へのポインター。この文字列は通常のパス解決規則に従い、埋め込み環境文字列 (%SystemRoot% など) を含めることができます。これらの環境文字列は、アプリケーションに代わって Ws2_32.dll が後でプロバイダー DLL をロードする必要が生じたときに展開されます。埋め込み環境文字列が展開された後、Ws2_32.dll は結果の文字列を LoadLibrary 関数に渡し、この関数がプロバイダーをメモリにロードします。詳細については、LoadLibrary を参照してください。
lpProtocolInfoList	WSAPROTOCOL_INFOW*	in	WSAPROTOCOL_INFO 構造体の配列へのポインター。各構造体は、プロバイダーがサポートするプロトコル、アドレスファミリ、ソケットタイプを指定または変更します。
dwNumberOfEntries	DWORD	in	lpProtocolInfoList 配列内のエントリ数。
lpErrno	INT*	out	関数が失敗した場合のエラーコードへのポインター。

戻り値の型: INT

公式ドキュメント

指定されたトランスポートプロバイダーをシステム構成データベース内で変更します。

戻り値

エラーが発生しなかった場合、 WSCUpdateProvider は 0 を返します。それ以外の場合は SOCKET_ERROR を返し、特定のエラーコードが lpErrno パラメーターに返されます。

エラーコード	意味
WSAEFAULT	1 つ以上の引数が、ユーザーアドレス空間の有効な部分にありません。
WSAEINVAL	1 つ以上の引数が無効です。
WSANO_RECOVERY	回復不能なエラーが発生しました。このエラーは、次を含むいくつかの条件下で返されます。すなわち、ユーザーに Winsock レジストリへの書き込みに必要な管理者権限がない場合や、カタログエントリのオープンまたは書き込み時に障害が発生した場合です。
WSA_NOT_ENOUGH_MEMORY	利用可能なメモリが不足していました。このエラーは、新しいカタログエントリを割り当てるのに十分なメモリがない場合に返されます。

解説(Remarks)

WSCUpdateProvider 関数は、指定されたプロバイダーの Windows Sockets 2 構成情報を変更します。これはベースプロトコル、階層化プロトコル、プロトコルチェーンに適用できます。

Winsock 2 は階層化プロトコルに対応しています。階層化プロトコルとは、より高レベルの通信機能のみを実装し、リモートエンドポイントとの実際のデータ交換については下位のトランスポートスタックに依存するプロトコルです。階層化プロトコルの例としては、認証を実行し相互に合意した暗号化方式を確立するために、接続確立プロセスにプロトコルを追加するセキュリティレイヤーが挙げられます。このようなセキュリティプロトコルは、一般に TCP や SPX などの下位にある信頼性の高いトランスポートプロトコルのサービスを必要とします。ベースプロトコルという用語は、リモートエンドポイントとのデータ通信を実行できる TCP や SPX のようなプロトコルを指します。階層化プロトコルという用語は、単独では成立しないプロトコルを表すために使用されます。プロトコルチェーンは、1 つ以上の階層化プロトコルが連結され、ベースプロトコルによって固定されたものとして定義されます。ベースプロトコルでは、WSAPROTOCOL_INFO 構造体の ChainLen メンバーが、1 と定義された BASE_PROTOCOL に設定されます。階層化プロトコルでは、WSAPROTOCOL_INFO 構造体の ChainLen メンバーが、0 と定義された LAYERED_PROTOCOL に設定されます。プロトコルチェーンでは、WSAPROTOCOL_INFO 構造体の ChainLen メンバーが 1 より大きい値に設定されます。

成功すると、WSCUpdateProvider は WSAProviderConfigChange を呼び出すことにより、変更の通知を登録しているすべての該当アプリケーションへの通知を試みます。

WSCUpdateProvider 関数は、Administrators グループのメンバーとしてログオンしているユーザーのみが呼び出すことができます。Administrators グループのメンバーではないユーザーが WSCUpdateProvider を呼び出した場合、その関数呼び出しは失敗します。

Windows Vista または Windows Server 2008 上で動作するコンピューターでは、この関数はユーザーアカウント制御 (UAC) が原因で失敗することもあります。この関数を含むアプリケーションが、組み込み Administrator 以外の Administrators グループのメンバーとしてログオンしているユーザーによって実行された場合、マニフェストファイル内で requestedExecutionLevel が requireAdministrator に設定されてマークされていない限り、この呼び出しは失敗します。Windows Vista または Windows Server 2008 上のアプリケーションにこのマニフェストファイルがない場合、組み込み Administrator 以外の Administrators グループのメンバーとしてログオンしているユーザーは、この関数を成功させるために、組み込み Administrator として拡張シェル (管理者として実行) でアプリケーションを実行する必要があります。

ファイルのインストールやサービスプロバイダー固有の構成は、呼び出し元が実行する必要があります。

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

各言語での呼び出し定義

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

INT WSCUpdateProvider(
    GUID* lpProviderId,
    LPCWSTR lpszProviderDllPath,
    const WSAPROTOCOL_INFOW* lpProtocolInfoList,
    DWORD dwNumberOfEntries,
    INT* lpErrno
);

[DllImport("WS2_32.dll", ExactSpelling = true)]
static extern int WSCUpdateProvider(
    ref Guid lpProviderId,   // GUID*
    [MarshalAs(UnmanagedType.LPWStr)] string lpszProviderDllPath,   // LPCWSTR
    IntPtr lpProtocolInfoList,   // WSAPROTOCOL_INFOW*
    uint dwNumberOfEntries,   // DWORD
    out int lpErrno   // INT* out
);

<DllImport("WS2_32.dll", ExactSpelling:=True)>
Public Shared Function WSCUpdateProvider(
    ByRef lpProviderId As Guid,   ' GUID*
    <MarshalAs(UnmanagedType.LPWStr)> lpszProviderDllPath As String,   ' LPCWSTR
    lpProtocolInfoList As IntPtr,   ' WSAPROTOCOL_INFOW*
    dwNumberOfEntries As UInteger,   ' DWORD
    <Out> ByRef lpErrno As Integer   ' INT* out
) As Integer
End Function

' lpProviderId : GUID*
' lpszProviderDllPath : LPCWSTR
' lpProtocolInfoList : WSAPROTOCOL_INFOW*
' dwNumberOfEntries : DWORD
' lpErrno : INT* out
Declare PtrSafe Function WSCUpdateProvider Lib "ws2_32" ( _
    ByVal lpProviderId As LongPtr, _
    ByVal lpszProviderDllPath As LongPtr, _
    ByVal lpProtocolInfoList As LongPtr, _
    ByVal dwNumberOfEntries As Long, _
    ByRef lpErrno As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

WSCUpdateProvider = ctypes.windll.ws2_32.WSCUpdateProvider
WSCUpdateProvider.restype = ctypes.c_int
WSCUpdateProvider.argtypes = [
    ctypes.c_void_p,  # lpProviderId : GUID*
    wintypes.LPCWSTR,  # lpszProviderDllPath : LPCWSTR
    ctypes.c_void_p,  # lpProtocolInfoList : WSAPROTOCOL_INFOW*
    wintypes.DWORD,  # dwNumberOfEntries : DWORD
    ctypes.POINTER(ctypes.c_int),  # lpErrno : INT* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WS2_32.dll')
WSCUpdateProvider = Fiddle::Function.new(
  lib['WSCUpdateProvider'],
  [
    Fiddle::TYPE_VOIDP,  # lpProviderId : GUID*
    Fiddle::TYPE_VOIDP,  # lpszProviderDllPath : LPCWSTR
    Fiddle::TYPE_VOIDP,  # lpProtocolInfoList : WSAPROTOCOL_INFOW*
    -Fiddle::TYPE_INT,  # dwNumberOfEntries : DWORD
    Fiddle::TYPE_VOIDP,  # lpErrno : INT* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "ws2_32")]
extern "system" {
    fn WSCUpdateProvider(
        lpProviderId: *mut GUID,  // GUID*
        lpszProviderDllPath: *const u16,  // LPCWSTR
        lpProtocolInfoList: *const WSAPROTOCOL_INFOW,  // WSAPROTOCOL_INFOW*
        dwNumberOfEntries: u32,  // DWORD
        lpErrno: *mut i32  // INT* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("WS2_32.dll")]
public static extern int WSCUpdateProvider(ref Guid lpProviderId, [MarshalAs(UnmanagedType.LPWStr)] string lpszProviderDllPath, IntPtr lpProtocolInfoList, uint dwNumberOfEntries, out int lpErrno);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WS2_32_WSCUpdateProvider' -Namespace Win32 -PassThru
# $api::WSCUpdateProvider(lpProviderId, lpszProviderDllPath, lpProtocolInfoList, dwNumberOfEntries, lpErrno)

#uselib "WS2_32.dll"
#func global WSCUpdateProvider "WSCUpdateProvider" sptr, sptr, sptr, sptr, sptr
; WSCUpdateProvider varptr(lpProviderId), lpszProviderDllPath, varptr(lpProtocolInfoList), dwNumberOfEntries, varptr(lpErrno)   ; 戻り値は stat
; lpProviderId : GUID* -> "sptr"
; lpszProviderDllPath : LPCWSTR -> "sptr"
; lpProtocolInfoList : WSAPROTOCOL_INFOW* -> "sptr"
; dwNumberOfEntries : DWORD -> "sptr"
; lpErrno : INT* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "WS2_32.dll"
#cfunc global WSCUpdateProvider "WSCUpdateProvider" var, wstr, var, int, var
; res = WSCUpdateProvider(lpProviderId, lpszProviderDllPath, lpProtocolInfoList, dwNumberOfEntries, lpErrno)
; lpProviderId : GUID* -> "var"
; lpszProviderDllPath : LPCWSTR -> "wstr"
; lpProtocolInfoList : WSAPROTOCOL_INFOW* -> "var"
; dwNumberOfEntries : DWORD -> "int"
; lpErrno : INT* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "WS2_32.dll"
#cfunc global WSCUpdateProvider "WSCUpdateProvider" sptr, wstr, sptr, int, sptr
; res = WSCUpdateProvider(varptr(lpProviderId), lpszProviderDllPath, varptr(lpProtocolInfoList), dwNumberOfEntries, varptr(lpErrno))
; lpProviderId : GUID* -> "sptr"
; lpszProviderDllPath : LPCWSTR -> "wstr"
; lpProtocolInfoList : WSAPROTOCOL_INFOW* -> "sptr"
; dwNumberOfEntries : DWORD -> "int"
; lpErrno : INT* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。