Win32 API 日本語リファレンス
ホームNetworkManagement.WNet › WNetGetProviderNameW

WNetGetProviderNameW

関数
ネットワーク種別に対応するプロバイダー名を取得する(Unicode版)。
DLLMPR.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

// MPR.dll  (Unicode / -W)
#include <windows.h>

WIN32_ERROR WNetGetProviderNameW(
    DWORD dwNetType,
    LPWSTR lpProviderName,
    DWORD* lpBufferSize
);

パラメーター

名前方向説明
dwNetTypeDWORDinプロバイダ名を取得するネットワーク種別(WNNC_NET_*)。
lpProviderNameLPWSTRoutネットワークプロバイダ名を受け取るワイドバッファ。
lpBufferSizeDWORD*inoutlpProviderNameの文字数を入出力で渡し、必要量を受け取る。

戻り値の型: WIN32_ERROR

各言語での呼び出し定義

// MPR.dll  (Unicode / -W)
#include <windows.h>

WIN32_ERROR WNetGetProviderNameW(
    DWORD dwNetType,
    LPWSTR lpProviderName,
    DWORD* lpBufferSize
);
[DllImport("MPR.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint WNetGetProviderNameW(
    uint dwNetType,   // DWORD
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpProviderName,   // LPWSTR out
    ref uint lpBufferSize   // DWORD* in/out
);
<DllImport("MPR.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function WNetGetProviderNameW(
    dwNetType As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPWStr)> lpProviderName As System.Text.StringBuilder,   ' LPWSTR out
    ByRef lpBufferSize As UInteger   ' DWORD* in/out
) As UInteger
End Function
' dwNetType : DWORD
' lpProviderName : LPWSTR out
' lpBufferSize : DWORD* in/out
Declare PtrSafe Function WNetGetProviderNameW Lib "mpr" ( _
    ByVal dwNetType As Long, _
    ByVal lpProviderName As LongPtr, _
    ByRef lpBufferSize As Long) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

WNetGetProviderNameW = ctypes.windll.mpr.WNetGetProviderNameW
WNetGetProviderNameW.restype = wintypes.DWORD
WNetGetProviderNameW.argtypes = [
    wintypes.DWORD,  # dwNetType : DWORD
    wintypes.LPWSTR,  # lpProviderName : LPWSTR out
    ctypes.POINTER(wintypes.DWORD),  # lpBufferSize : DWORD* in/out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('MPR.dll')
WNetGetProviderNameW = Fiddle::Function.new(
  lib['WNetGetProviderNameW'],
  [
    -Fiddle::TYPE_INT,  # dwNetType : DWORD
    Fiddle::TYPE_VOIDP,  # lpProviderName : LPWSTR out
    Fiddle::TYPE_VOIDP,  # lpBufferSize : DWORD* in/out
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "mpr")]
extern "system" {
    fn WNetGetProviderNameW(
        dwNetType: u32,  // DWORD
        lpProviderName: *mut u16,  // LPWSTR out
        lpBufferSize: *mut u32  // DWORD* in/out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("MPR.dll", CharSet = CharSet.Unicode)]
public static extern uint WNetGetProviderNameW(uint dwNetType, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpProviderName, ref uint lpBufferSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'MPR_WNetGetProviderNameW' -Namespace Win32 -PassThru
# $api::WNetGetProviderNameW(dwNetType, lpProviderName, lpBufferSize)
#uselib "MPR.dll"
#func global WNetGetProviderNameW "WNetGetProviderNameW" wptr, wptr, wptr
; WNetGetProviderNameW dwNetType, varptr(lpProviderName), varptr(lpBufferSize)   ; 戻り値は stat
; dwNetType : DWORD -> "wptr"
; lpProviderName : LPWSTR out -> "wptr"
; lpBufferSize : DWORD* in/out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "MPR.dll"
#cfunc global WNetGetProviderNameW "WNetGetProviderNameW" int, var, var
; res = WNetGetProviderNameW(dwNetType, lpProviderName, lpBufferSize)
; dwNetType : DWORD -> "int"
; lpProviderName : LPWSTR out -> "var"
; lpBufferSize : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; WIN32_ERROR WNetGetProviderNameW(DWORD dwNetType, LPWSTR lpProviderName, DWORD* lpBufferSize)
#uselib "MPR.dll"
#cfunc global WNetGetProviderNameW "WNetGetProviderNameW" int, var, var
; res = WNetGetProviderNameW(dwNetType, lpProviderName, lpBufferSize)
; dwNetType : DWORD -> "int"
; lpProviderName : LPWSTR out -> "var"
; lpBufferSize : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	mpr = windows.NewLazySystemDLL("MPR.dll")
	procWNetGetProviderNameW = mpr.NewProc("WNetGetProviderNameW")
)

// dwNetType (DWORD), lpProviderName (LPWSTR out), lpBufferSize (DWORD* in/out)
r1, _, err := procWNetGetProviderNameW.Call(
	uintptr(dwNetType),
	uintptr(lpProviderName),
	uintptr(lpBufferSize),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // WIN32_ERROR
function WNetGetProviderNameW(
  dwNetType: DWORD;   // DWORD
  lpProviderName: PWideChar;   // LPWSTR out
  lpBufferSize: Pointer   // DWORD* in/out
): DWORD; stdcall;
  external 'MPR.dll' name 'WNetGetProviderNameW';
result := DllCall("MPR\WNetGetProviderNameW"
    , "UInt", dwNetType   ; DWORD
    , "Ptr", lpProviderName   ; LPWSTR out
    , "Ptr", lpBufferSize   ; DWORD* in/out
    , "UInt")   ; return: WIN32_ERROR
●WNetGetProviderNameW(dwNetType, lpProviderName, lpBufferSize) = DLL("MPR.dll", "dword WNetGetProviderNameW(dword, char*, void*)")
# 呼び出し: WNetGetProviderNameW(dwNetType, lpProviderName, lpBufferSize)
# dwNetType : DWORD -> "dword"
# lpProviderName : LPWSTR out -> "char*"
# lpBufferSize : DWORD* in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "mpr" fn WNetGetProviderNameW(
    dwNetType: u32, // DWORD
    lpProviderName: [*c]u16, // LPWSTR out
    lpBufferSize: [*c]u32 // DWORD* in/out
) callconv(std.os.windows.WINAPI) u32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc WNetGetProviderNameW(
    dwNetType: uint32,  # DWORD
    lpProviderName: ptr uint16,  # LPWSTR out
    lpBufferSize: ptr uint32  # DWORD* in/out
): uint32 {.importc: "WNetGetProviderNameW", stdcall, dynlib: "MPR.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "mpr");
extern(Windows)
uint WNetGetProviderNameW(
    uint dwNetType,   // DWORD
    wchar* lpProviderName,   // LPWSTR out
    uint* lpBufferSize   // DWORD* in/out
);
ccall((:WNetGetProviderNameW, "MPR.dll"), stdcall, UInt32,
      (UInt32, Ptr{UInt16}, Ptr{UInt32}),
      dwNetType, lpProviderName, lpBufferSize)
# dwNetType : DWORD -> UInt32
# lpProviderName : LPWSTR out -> Ptr{UInt16}
# lpBufferSize : DWORD* in/out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
uint32_t WNetGetProviderNameW(
    uint32_t dwNetType,
    uint16_t* lpProviderName,
    uint32_t* lpBufferSize);
]]
local mpr = ffi.load("mpr")
-- mpr.WNetGetProviderNameW(dwNetType, lpProviderName, lpBufferSize)
-- dwNetType : DWORD
-- lpProviderName : LPWSTR out
-- lpBufferSize : DWORD* in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('MPR.dll');
const WNetGetProviderNameW = lib.func('__stdcall', 'WNetGetProviderNameW', 'uint32_t', ['uint32_t', 'uint16_t *', 'uint32_t *']);
// WNetGetProviderNameW(dwNetType, lpProviderName, lpBufferSize)
// dwNetType : DWORD -> 'uint32_t'
// lpProviderName : LPWSTR out -> 'uint16_t *'
// lpBufferSize : DWORD* in/out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("MPR.dll", {
  WNetGetProviderNameW: { parameters: ["u32", "buffer", "pointer"], result: "u32" },
});
// lib.symbols.WNetGetProviderNameW(dwNetType, lpProviderName, lpBufferSize)
// dwNetType : DWORD -> "u32"
// lpProviderName : LPWSTR out -> "buffer"
// lpBufferSize : DWORD* in/out -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t WNetGetProviderNameW(
    uint32_t dwNetType,
    uint16_t* lpProviderName,
    uint32_t* lpBufferSize);
C, "MPR.dll");
// $ffi->WNetGetProviderNameW(dwNetType, lpProviderName, lpBufferSize);
// dwNetType : DWORD
// lpProviderName : LPWSTR out
// lpBufferSize : DWORD* in/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 Mpr extends StdCallLibrary {
    Mpr INSTANCE = Native.load("mpr", Mpr.class, W32APIOptions.UNICODE_OPTIONS);
    int WNetGetProviderNameW(
        int dwNetType,   // DWORD
        char[] lpProviderName,   // LPWSTR out
        IntByReference lpBufferSize   // DWORD* in/out
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("mpr")]
lib LibMPR
  fun WNetGetProviderNameW = WNetGetProviderNameW(
    dwNetType : UInt32,   # DWORD
    lpProviderName : UInt16*,   # LPWSTR out
    lpBufferSize : UInt32*   # DWORD* in/out
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef WNetGetProviderNameWNative = Uint32 Function(Uint32, Pointer<Utf16>, Pointer<Uint32>);
typedef WNetGetProviderNameWDart = int Function(int, Pointer<Utf16>, Pointer<Uint32>);
final WNetGetProviderNameW = DynamicLibrary.open('MPR.dll')
    .lookupFunction<WNetGetProviderNameWNative, WNetGetProviderNameWDart>('WNetGetProviderNameW');
// dwNetType : DWORD -> Uint32
// lpProviderName : LPWSTR out -> Pointer<Utf16>
// lpBufferSize : DWORD* in/out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function WNetGetProviderNameW(
  dwNetType: DWORD;   // DWORD
  lpProviderName: PWideChar;   // LPWSTR out
  lpBufferSize: Pointer   // DWORD* in/out
): DWORD; stdcall;
  external 'MPR.dll' name 'WNetGetProviderNameW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "WNetGetProviderNameW"
  c_WNetGetProviderNameW :: Word32 -> CWString -> Ptr Word32 -> IO Word32
-- dwNetType : DWORD -> Word32
-- lpProviderName : LPWSTR out -> CWString
-- lpBufferSize : DWORD* in/out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let wnetgetprovidernamew =
  foreign "WNetGetProviderNameW"
    (uint32_t @-> (ptr uint16_t) @-> (ptr uint32_t) @-> returning uint32_t)
(* dwNetType : DWORD -> uint32_t *)
(* lpProviderName : LPWSTR out -> (ptr uint16_t) *)
(* lpBufferSize : DWORD* in/out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library mpr (t "MPR.dll"))
(cffi:use-foreign-library mpr)

(cffi:defcfun ("WNetGetProviderNameW" wnet-get-provider-name-w :convention :stdcall) :uint32
  (dw-net-type :uint32)   ; DWORD
  (lp-provider-name :pointer)   ; LPWSTR out
  (lp-buffer-size :pointer))   ; DWORD* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WNetGetProviderNameW = Win32::API::More->new('MPR',
    'DWORD WNetGetProviderNameW(DWORD dwNetType, LPWSTR lpProviderName, LPVOID lpBufferSize)');
# my $ret = $WNetGetProviderNameW->Call($dwNetType, $lpProviderName, $lpBufferSize);
# dwNetType : DWORD -> DWORD
# lpProviderName : LPWSTR out -> LPWSTR
# lpBufferSize : DWORD* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い
使用する型