ホーム › Networking.WinSock › WSCGetProviderPath32

WSCGetProviderPath32

関数

32ビットカタログのプロバイダDLLパスを取得する。

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

シグネチャ

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

INT WSCGetProviderPath32(
    GUID* lpProviderId,
    LPWSTR lpszProviderDllPath,
    INT* lpProviderDllPathLen,
    INT* lpErrno
);

パラメーター

名前	型	方向	説明
lpProviderId	GUID*	in	プロバイダーのローカルで一意の識別子。この値は WSCEnumProtocols32 を使用して取得します。
lpszProviderDllPath	LPWSTR	out	プロバイダー DLL のパス文字列が返されるバッファーへのポインター。パスは null で終わる文字列であり、%SystemRoot% などの埋め込み環境文字列は展開されていません。
lpProviderDllPathLen	INT*	inout	lpszProviderDllPath パラメーターが指すバッファーのサイズ(文字単位)。
lpErrno	INT*	out	エラーコードへのポインター。

戻り値の型: INT

公式ドキュメント

指定された 32 ビットプロバイダーの DLL パスを取得します。Note この呼び出しは、64 ビットプラットフォームで使用する WSCGetProviderPath の厳密な 32 ビット版です。64 ビットプロセスが 32 ビットカタログにアクセスできるようにするために提供されています。

戻り値

エラーが発生しない場合、WSCGetProviderPath32 は 0 を返します。それ以外の場合は SOCKET_ERROR を返します。具体的なエラーコードは lpErrno から取得できます。

エラーコード	意味
WSAEINVAL	lpProviderId パラメーターが有効なプロバイダーを指定していません。
WSAEFAULT	lpszProviderDllPath または lpErrno パラメーターがユーザーアドレス空間の有効な部分にないか、lpProviderDllPathLen が小さすぎます。

解説(Remarks)

WSCGetProviderPath32 は WSCGetProviderPath の厳密な 32 ビット版です。64 ビットコンピューターでは、明確に 32 ビットではないすべての呼び出し(たとえば末尾が "32" で終わらないすべての関数)は、ネイティブの 64 ビットカタログに対して動作します。64 ビットコンピューター上で実行されるプロセスは、厳密な 32 ビットカタログに対して動作し互換性を維持するために、専用の 32 ビット関数呼び出しを使用する必要があります。専用の 32 ビット呼び出しの定義とセマンティクスは、ネイティブの対応する関数と同じです。

WSCGetProviderPath32 関数は、指定されたプロバイダーの DLL パスを取得します。DLL パスには %SystemRoot% などの埋め込み環境文字列が含まれている場合があるため、Windows の LoadLibrary 関数で使用する前に展開する必要があります。詳細については、LoadLibrary を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 WSCGetProviderPath32(
    GUID* lpProviderId,
    LPWSTR lpszProviderDllPath,
    INT* lpProviderDllPathLen,
    INT* lpErrno
);

[DllImport("WS2_32.dll", ExactSpelling = true)]
static extern int WSCGetProviderPath32(
    ref Guid lpProviderId,   // GUID*
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpszProviderDllPath,   // LPWSTR out
    ref int lpProviderDllPathLen,   // INT* in/out
    out int lpErrno   // INT* out
);

<DllImport("WS2_32.dll", ExactSpelling:=True)>
Public Shared Function WSCGetProviderPath32(
    ByRef lpProviderId As Guid,   ' GUID*
    <MarshalAs(UnmanagedType.LPWStr)> lpszProviderDllPath As System.Text.StringBuilder,   ' LPWSTR out
    ByRef lpProviderDllPathLen As Integer,   ' INT* in/out
    <Out> ByRef lpErrno As Integer   ' INT* out
) As Integer
End Function

' lpProviderId : GUID*
' lpszProviderDllPath : LPWSTR out
' lpProviderDllPathLen : INT* in/out
' lpErrno : INT* out
Declare PtrSafe Function WSCGetProviderPath32 Lib "ws2_32" ( _
    ByVal lpProviderId As LongPtr, _
    ByVal lpszProviderDllPath As LongPtr, _
    ByRef lpProviderDllPathLen 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

WSCGetProviderPath32 = ctypes.windll.ws2_32.WSCGetProviderPath32
WSCGetProviderPath32.restype = ctypes.c_int
WSCGetProviderPath32.argtypes = [
    ctypes.c_void_p,  # lpProviderId : GUID*
    wintypes.LPWSTR,  # lpszProviderDllPath : LPWSTR out
    ctypes.POINTER(ctypes.c_int),  # lpProviderDllPathLen : INT* in/out
    ctypes.POINTER(ctypes.c_int),  # lpErrno : INT* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WS2_32.dll')
WSCGetProviderPath32 = Fiddle::Function.new(
  lib['WSCGetProviderPath32'],
  [
    Fiddle::TYPE_VOIDP,  # lpProviderId : GUID*
    Fiddle::TYPE_VOIDP,  # lpszProviderDllPath : LPWSTR out
    Fiddle::TYPE_VOIDP,  # lpProviderDllPathLen : INT* in/out
    Fiddle::TYPE_VOIDP,  # lpErrno : INT* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "ws2_32")]
extern "system" {
    fn WSCGetProviderPath32(
        lpProviderId: *mut GUID,  // GUID*
        lpszProviderDllPath: *mut u16,  // LPWSTR out
        lpProviderDllPathLen: *mut i32,  // INT* in/out
        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 WSCGetProviderPath32(ref Guid lpProviderId, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpszProviderDllPath, ref int lpProviderDllPathLen, out int lpErrno);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WS2_32_WSCGetProviderPath32' -Namespace Win32 -PassThru
# $api::WSCGetProviderPath32(lpProviderId, lpszProviderDllPath, lpProviderDllPathLen, lpErrno)

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

出力引数:

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