Win32 API 日本語リファレンス
ホームNetworking.WinSock › WSCInstallProvider

WSCInstallProvider

関数
新しいトランスポートプロバイダーを登録する。
DLLWS2_32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

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

パラメーター

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

戻り値の型: INT

公式ドキュメント

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

戻り値

WSCInstallProvider が成功した場合は 0 を返します。それ以外の場合は SOCKET_ERROR を返し、lpErrno パラメーターに固有のエラーコードが返されます。

エラーコード 意味
WSAEFAULT
引数の 1 つ以上がユーザーアドレス空間の有効な部分にありません。
WSAEINVAL
引数の 1 つ以上が無効です。
WSAENOBUFS
バッファー用のメモリを割り当てられません。
WSANO_RECOVERY
回復不能なエラーが発生しました。このエラーは次のようないくつかの条件で返されます。プロバイダーが既にインストールされている、ユーザーに Winsock レジストリへの書き込みに必要な管理者権限がない、またはカタログエントリの作成もしくはインストール時に障害が発生した場合などです。
WSASYSCALLFAILURE
失敗することのないはずのシステムコールが失敗しました。
WSA_NOT_ENOUGH_MEMORY
使用可能なメモリが不足していました。このエラーは、新しいカタログエントリを割り当てるのに十分なメモリがない場合に返されます。

解説(Remarks)

WSCInstallProvider は、単一のトランスポートサービスプロバイダーをインストールするために使用されます。このルーチンは、指定されたプロバイダーに必要な共通の Windows Sockets 2 構成情報を作成します。これは、ベースプロトコル、レイヤードプロトコル、プロトコルチェーンに適用できます。レイヤードサービスプロバイダーをインストールする場合は、WSCInstallProviderAndChains を使用する必要があります。WSCInstallProviderAndChains は、1 回の関数呼び出しでレイヤードプロトコルと 1 つ以上のプロトコルチェーンをインストールできます。同じ作業を WSCInstallProvider で行うには、複数の関数呼び出しが必要になります。

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

lpProtocolInfoList パラメーターには、インストールするプロトコルエントリのリストが含まれます。WSCInstallProvider の呼び出し側は、適切なプロトコルエントリを設定する責任があります。lpProtocolInfoList パラメーターは NULL であってはなりません。

この呼び出しが正常に完了すると、以降の WSAEnumProtocols または WSCEnumProtocols の呼び出しで、新しく作成されたプロトコルエントリが返されます。なお、Windows 環境では、WSAEnumProtocols および WSCEnumProtocols が返すときに新しいエントリが含まれるのは、WSCInstallProvider の正常完了後に WSAStartup を呼び出して作成された Ws_32.dll のインスタンスのみです。

WSAEnumProtocols 関数はレイヤードプロトコルエントリを列挙しませんが、WSCEnumProtocols は列挙します。

成功すると、WSCInstallProviderWSAProviderConfigChange を呼び出して、変更の通知を登録しているすべての関連アプリケーションに通知しようとします。

WSCInstallProvider 関数は、Administrators グループのメンバーとしてログオンしているユーザーのみが呼び出すことができます。Administrators グループのメンバーではないユーザーが WSCInstallProvider を呼び出した場合、この関数呼び出しは失敗し、lpErrno パラメーターに WSANO_RECOVERY が返されます。 Windows Vista または Windows Server 2008 を実行しているコンピューターでは、ユーザーアカウント制御 (UAC) が原因でこの関数が失敗することもあります。この関数を含むアプリケーションが、組み込み Administrator 以外の Administrators グループのメンバーとしてログオンしたユーザーによって実行された場合、マニフェストファイルで requestedExecutionLevelrequireAdministrator に設定されてマークされていない限り、この呼び出しは失敗します。Windows Vista または Windows Server 2008 上のアプリケーションにこのマニフェストファイルがない場合、組み込み Administrator 以外の Administrators グループのメンバーとしてログオンしたユーザーは、この関数を成功させるために、組み込み Administrator として拡張シェル (RunAs 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 WSCInstallProvider(
    GUID* lpProviderId,
    LPCWSTR lpszProviderDllPath,
    const WSAPROTOCOL_INFOW* lpProtocolInfoList,
    DWORD dwNumberOfEntries,
    INT* lpErrno
);
[DllImport("WS2_32.dll", ExactSpelling = true)]
static extern int WSCInstallProvider(
    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 WSCInstallProvider(
    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 WSCInstallProvider 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

WSCInstallProvider = ctypes.windll.ws2_32.WSCInstallProvider
WSCInstallProvider.restype = ctypes.c_int
WSCInstallProvider.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')
WSCInstallProvider = Fiddle::Function.new(
  lib['WSCInstallProvider'],
  [
    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 WSCInstallProvider(
        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 WSCInstallProvider(ref Guid lpProviderId, [MarshalAs(UnmanagedType.LPWStr)] string lpszProviderDllPath, IntPtr lpProtocolInfoList, uint dwNumberOfEntries, out int lpErrno);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WS2_32_WSCInstallProvider' -Namespace Win32 -PassThru
# $api::WSCInstallProvider(lpProviderId, lpszProviderDllPath, lpProtocolInfoList, dwNumberOfEntries, lpErrno)
#uselib "WS2_32.dll"
#func global WSCInstallProvider "WSCInstallProvider" sptr, sptr, sptr, sptr, sptr
; WSCInstallProvider 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 WSCInstallProvider "WSCInstallProvider" var, wstr, var, int, var
; res = WSCInstallProvider(lpProviderId, lpszProviderDllPath, lpProtocolInfoList, dwNumberOfEntries, lpErrno)
; lpProviderId : GUID* -> "var"
; lpszProviderDllPath : LPCWSTR -> "wstr"
; lpProtocolInfoList : WSAPROTOCOL_INFOW* -> "var"
; dwNumberOfEntries : DWORD -> "int"
; lpErrno : INT* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; INT WSCInstallProvider(GUID* lpProviderId, LPCWSTR lpszProviderDllPath, WSAPROTOCOL_INFOW* lpProtocolInfoList, DWORD dwNumberOfEntries, INT* lpErrno)
#uselib "WS2_32.dll"
#cfunc global WSCInstallProvider "WSCInstallProvider" var, wstr, var, int, var
; res = WSCInstallProvider(lpProviderId, lpszProviderDllPath, lpProtocolInfoList, dwNumberOfEntries, lpErrno)
; lpProviderId : GUID* -> "var"
; lpszProviderDllPath : LPCWSTR -> "wstr"
; lpProtocolInfoList : WSAPROTOCOL_INFOW* -> "var"
; dwNumberOfEntries : DWORD -> "int"
; lpErrno : INT* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	ws2_32 = windows.NewLazySystemDLL("WS2_32.dll")
	procWSCInstallProvider = ws2_32.NewProc("WSCInstallProvider")
)

// lpProviderId (GUID*), lpszProviderDllPath (LPCWSTR), lpProtocolInfoList (WSAPROTOCOL_INFOW*), dwNumberOfEntries (DWORD), lpErrno (INT* out)
r1, _, err := procWSCInstallProvider.Call(
	uintptr(lpProviderId),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpszProviderDllPath))),
	uintptr(lpProtocolInfoList),
	uintptr(dwNumberOfEntries),
	uintptr(lpErrno),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // INT
function WSCInstallProvider(
  lpProviderId: PGUID;   // GUID*
  lpszProviderDllPath: PWideChar;   // LPCWSTR
  lpProtocolInfoList: Pointer;   // WSAPROTOCOL_INFOW*
  dwNumberOfEntries: DWORD;   // DWORD
  lpErrno: Pointer   // INT* out
): Integer; stdcall;
  external 'WS2_32.dll' name 'WSCInstallProvider';
result := DllCall("WS2_32\WSCInstallProvider"
    , "Ptr", lpProviderId   ; GUID*
    , "WStr", lpszProviderDllPath   ; LPCWSTR
    , "Ptr", lpProtocolInfoList   ; WSAPROTOCOL_INFOW*
    , "UInt", dwNumberOfEntries   ; DWORD
    , "Ptr", lpErrno   ; INT* out
    , "Int")   ; return: INT
●WSCInstallProvider(lpProviderId, lpszProviderDllPath, lpProtocolInfoList, dwNumberOfEntries, lpErrno) = DLL("WS2_32.dll", "int WSCInstallProvider(void*, char*, void*, dword, void*)")
# 呼び出し: WSCInstallProvider(lpProviderId, lpszProviderDllPath, lpProtocolInfoList, dwNumberOfEntries, lpErrno)
# lpProviderId : GUID* -> "void*"
# lpszProviderDllPath : LPCWSTR -> "char*"
# lpProtocolInfoList : WSAPROTOCOL_INFOW* -> "void*"
# dwNumberOfEntries : DWORD -> "dword"
# lpErrno : INT* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "ws2_32" fn WSCInstallProvider(
    lpProviderId: [*c]GUID, // GUID*
    lpszProviderDllPath: [*c]const u16, // LPCWSTR
    lpProtocolInfoList: [*c]WSAPROTOCOL_INFOW, // WSAPROTOCOL_INFOW*
    dwNumberOfEntries: u32, // DWORD
    lpErrno: [*c]i32 // INT* out
) callconv(std.os.windows.WINAPI) i32;
proc WSCInstallProvider(
    lpProviderId: ptr GUID,  # GUID*
    lpszProviderDllPath: WideCString,  # LPCWSTR
    lpProtocolInfoList: ptr WSAPROTOCOL_INFOW,  # WSAPROTOCOL_INFOW*
    dwNumberOfEntries: uint32,  # DWORD
    lpErrno: ptr int32  # INT* out
): int32 {.importc: "WSCInstallProvider", stdcall, dynlib: "WS2_32.dll".}
pragma(lib, "ws2_32");
extern(Windows)
int WSCInstallProvider(
    GUID* lpProviderId,   // GUID*
    const(wchar)* lpszProviderDllPath,   // LPCWSTR
    WSAPROTOCOL_INFOW* lpProtocolInfoList,   // WSAPROTOCOL_INFOW*
    uint dwNumberOfEntries,   // DWORD
    int* lpErrno   // INT* out
);
ccall((:WSCInstallProvider, "WS2_32.dll"), stdcall, Int32,
      (Ptr{GUID}, Cwstring, Ptr{WSAPROTOCOL_INFOW}, UInt32, Ptr{Int32}),
      lpProviderId, lpszProviderDllPath, lpProtocolInfoList, dwNumberOfEntries, lpErrno)
# lpProviderId : GUID* -> Ptr{GUID}
# lpszProviderDllPath : LPCWSTR -> Cwstring
# lpProtocolInfoList : WSAPROTOCOL_INFOW* -> Ptr{WSAPROTOCOL_INFOW}
# dwNumberOfEntries : DWORD -> UInt32
# lpErrno : INT* out -> Ptr{Int32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t WSCInstallProvider(
    void* lpProviderId,
    const uint16_t* lpszProviderDllPath,
    void* lpProtocolInfoList,
    uint32_t dwNumberOfEntries,
    int32_t* lpErrno);
]]
local ws2_32 = ffi.load("ws2_32")
-- ws2_32.WSCInstallProvider(lpProviderId, lpszProviderDllPath, lpProtocolInfoList, dwNumberOfEntries, lpErrno)
-- lpProviderId : GUID*
-- lpszProviderDllPath : LPCWSTR
-- lpProtocolInfoList : WSAPROTOCOL_INFOW*
-- dwNumberOfEntries : DWORD
-- lpErrno : INT* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('WS2_32.dll');
const WSCInstallProvider = lib.func('__stdcall', 'WSCInstallProvider', 'int32_t', ['void *', 'str16', 'void *', 'uint32_t', 'int32_t *']);
// WSCInstallProvider(lpProviderId, lpszProviderDllPath, lpProtocolInfoList, dwNumberOfEntries, lpErrno)
// lpProviderId : GUID* -> 'void *'
// lpszProviderDllPath : LPCWSTR -> 'str16'
// lpProtocolInfoList : WSAPROTOCOL_INFOW* -> 'void *'
// dwNumberOfEntries : DWORD -> 'uint32_t'
// lpErrno : INT* out -> 'int32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("WS2_32.dll", {
  WSCInstallProvider: { parameters: ["pointer", "buffer", "pointer", "u32", "pointer"], result: "i32" },
});
// lib.symbols.WSCInstallProvider(lpProviderId, lpszProviderDllPath, lpProtocolInfoList, dwNumberOfEntries, lpErrno)
// lpProviderId : GUID* -> "pointer"
// lpszProviderDllPath : LPCWSTR -> "buffer"
// lpProtocolInfoList : WSAPROTOCOL_INFOW* -> "pointer"
// dwNumberOfEntries : DWORD -> "u32"
// lpErrno : INT* out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t WSCInstallProvider(
    void* lpProviderId,
    const uint16_t* lpszProviderDllPath,
    void* lpProtocolInfoList,
    uint32_t dwNumberOfEntries,
    int32_t* lpErrno);
C, "WS2_32.dll");
// $ffi->WSCInstallProvider(lpProviderId, lpszProviderDllPath, lpProtocolInfoList, dwNumberOfEntries, lpErrno);
// lpProviderId : GUID*
// lpszProviderDllPath : LPCWSTR
// lpProtocolInfoList : WSAPROTOCOL_INFOW*
// dwNumberOfEntries : DWORD
// lpErrno : INT* out
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Ws2_32 extends StdCallLibrary {
    Ws2_32 INSTANCE = Native.load("ws2_32", Ws2_32.class);
    int WSCInstallProvider(
        Pointer lpProviderId,   // GUID*
        WString lpszProviderDllPath,   // LPCWSTR
        Pointer lpProtocolInfoList,   // WSAPROTOCOL_INFOW*
        int dwNumberOfEntries,   // DWORD
        IntByReference lpErrno   // INT* out
    );
}
@[Link("ws2_32")]
lib LibWS2_32
  fun WSCInstallProvider = WSCInstallProvider(
    lpProviderId : GUID*,   # GUID*
    lpszProviderDllPath : UInt16*,   # LPCWSTR
    lpProtocolInfoList : WSAPROTOCOL_INFOW*,   # WSAPROTOCOL_INFOW*
    dwNumberOfEntries : UInt32,   # DWORD
    lpErrno : Int32*   # INT* out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef WSCInstallProviderNative = Int32 Function(Pointer<Void>, Pointer<Utf16>, Pointer<Void>, Uint32, Pointer<Int32>);
typedef WSCInstallProviderDart = int Function(Pointer<Void>, Pointer<Utf16>, Pointer<Void>, int, Pointer<Int32>);
final WSCInstallProvider = DynamicLibrary.open('WS2_32.dll')
    .lookupFunction<WSCInstallProviderNative, WSCInstallProviderDart>('WSCInstallProvider');
// lpProviderId : GUID* -> Pointer<Void>
// lpszProviderDllPath : LPCWSTR -> Pointer<Utf16>
// lpProtocolInfoList : WSAPROTOCOL_INFOW* -> Pointer<Void>
// dwNumberOfEntries : DWORD -> Uint32
// lpErrno : INT* out -> Pointer<Int32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function WSCInstallProvider(
  lpProviderId: PGUID;   // GUID*
  lpszProviderDllPath: PWideChar;   // LPCWSTR
  lpProtocolInfoList: Pointer;   // WSAPROTOCOL_INFOW*
  dwNumberOfEntries: DWORD;   // DWORD
  lpErrno: Pointer   // INT* out
): Integer; stdcall;
  external 'WS2_32.dll' name 'WSCInstallProvider';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "WSCInstallProvider"
  c_WSCInstallProvider :: Ptr () -> CWString -> Ptr () -> Word32 -> Ptr Int32 -> IO Int32
-- lpProviderId : GUID* -> Ptr ()
-- lpszProviderDllPath : LPCWSTR -> CWString
-- lpProtocolInfoList : WSAPROTOCOL_INFOW* -> Ptr ()
-- dwNumberOfEntries : DWORD -> Word32
-- lpErrno : INT* out -> Ptr Int32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let wscinstallprovider =
  foreign "WSCInstallProvider"
    ((ptr void) @-> (ptr uint16_t) @-> (ptr void) @-> uint32_t @-> (ptr int32_t) @-> returning int32_t)
(* lpProviderId : GUID* -> (ptr void) *)
(* lpszProviderDllPath : LPCWSTR -> (ptr uint16_t) *)
(* lpProtocolInfoList : WSAPROTOCOL_INFOW* -> (ptr void) *)
(* dwNumberOfEntries : DWORD -> uint32_t *)
(* lpErrno : INT* out -> (ptr int32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library ws2_32 (t "WS2_32.dll"))
(cffi:use-foreign-library ws2_32)

(cffi:defcfun ("WSCInstallProvider" wscinstall-provider :convention :stdcall) :int32
  (lp-provider-id :pointer)   ; GUID*
  (lpsz-provider-dll-path (:string :encoding :utf-16le))   ; LPCWSTR
  (lp-protocol-info-list :pointer)   ; WSAPROTOCOL_INFOW*
  (dw-number-of-entries :uint32)   ; DWORD
  (lp-errno :pointer))   ; INT* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WSCInstallProvider = Win32::API::More->new('WS2_32',
    'int WSCInstallProvider(LPVOID lpProviderId, LPCWSTR lpszProviderDllPath, LPVOID lpProtocolInfoList, DWORD dwNumberOfEntries, LPVOID lpErrno)');
# my $ret = $WSCInstallProvider->Call($lpProviderId, $lpszProviderDllPath, $lpProtocolInfoList, $dwNumberOfEntries, $lpErrno);
# lpProviderId : GUID* -> LPVOID
# lpszProviderDllPath : LPCWSTR -> LPCWSTR
# lpProtocolInfoList : WSAPROTOCOL_INFOW* -> LPVOID
# dwNumberOfEntries : DWORD -> DWORD
# lpErrno : INT* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

類似 API
公式の関連項目
使用する型