Win32 API 日本語リファレンス
ホームGraphics.Printing › EnumPortsW

EnumPortsW

関数
使用可能なプリンターポートを列挙する。
DLLwinspool.drv文字セットUnicode (-W)呼出規約winapi

シグネチャ

// winspool.drv  (Unicode / -W)
#include <windows.h>

BOOL EnumPortsW(
    LPWSTR pName,   // optional
    DWORD Level,
    BYTE* pPort,   // optional
    DWORD cbBuf,
    DWORD* pcbNeeded,
    DWORD* pcReturned
);

パラメーター

名前方向
pNameLPWSTRinoptional
LevelDWORDin
pPortBYTE*outoptional
cbBufDWORDin
pcbNeededDWORD*out
pcReturnedDWORD*out

戻り値の型: BOOL

各言語での呼び出し定義

// winspool.drv  (Unicode / -W)
#include <windows.h>

BOOL EnumPortsW(
    LPWSTR pName,   // optional
    DWORD Level,
    BYTE* pPort,   // optional
    DWORD cbBuf,
    DWORD* pcbNeeded,
    DWORD* pcReturned
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("winspool.drv", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern bool EnumPortsW(
    [MarshalAs(UnmanagedType.LPWStr)] string pName,   // LPWSTR optional
    uint Level,   // DWORD
    IntPtr pPort,   // BYTE* optional, out
    uint cbBuf,   // DWORD
    out uint pcbNeeded,   // DWORD* out
    out uint pcReturned   // DWORD* out
);
<DllImport("winspool.drv", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function EnumPortsW(
    <MarshalAs(UnmanagedType.LPWStr)> pName As String,   ' LPWSTR optional
    Level As UInteger,   ' DWORD
    pPort As IntPtr,   ' BYTE* optional, out
    cbBuf As UInteger,   ' DWORD
    <Out> ByRef pcbNeeded As UInteger,   ' DWORD* out
    <Out> ByRef pcReturned As UInteger   ' DWORD* out
) As Boolean
End Function
' pName : LPWSTR optional
' Level : DWORD
' pPort : BYTE* optional, out
' cbBuf : DWORD
' pcbNeeded : DWORD* out
' pcReturned : DWORD* out
Declare PtrSafe Function EnumPortsW Lib "winspool.drv" ( _
    ByVal pName As LongPtr, _
    ByVal Level As Long, _
    ByVal pPort As LongPtr, _
    ByVal cbBuf As Long, _
    ByRef pcbNeeded As Long, _
    ByRef pcReturned 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

EnumPortsW = ctypes.windll.LoadLibrary("winspool.drv").EnumPortsW
EnumPortsW.restype = wintypes.BOOL
EnumPortsW.argtypes = [
    wintypes.LPCWSTR,  # pName : LPWSTR optional
    wintypes.DWORD,  # Level : DWORD
    ctypes.POINTER(ctypes.c_ubyte),  # pPort : BYTE* optional, out
    wintypes.DWORD,  # cbBuf : DWORD
    ctypes.POINTER(wintypes.DWORD),  # pcbNeeded : DWORD* out
    ctypes.POINTER(wintypes.DWORD),  # pcReturned : DWORD* out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('winspool.drv')
EnumPortsW = Fiddle::Function.new(
  lib['EnumPortsW'],
  [
    Fiddle::TYPE_VOIDP,  # pName : LPWSTR optional
    -Fiddle::TYPE_INT,  # Level : DWORD
    Fiddle::TYPE_VOIDP,  # pPort : BYTE* optional, out
    -Fiddle::TYPE_INT,  # cbBuf : DWORD
    Fiddle::TYPE_VOIDP,  # pcbNeeded : DWORD* out
    Fiddle::TYPE_VOIDP,  # pcReturned : DWORD* out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "winspool.drv")]
extern "system" {
    fn EnumPortsW(
        pName: *mut u16,  // LPWSTR optional
        Level: u32,  // DWORD
        pPort: *mut u8,  // BYTE* optional, out
        cbBuf: u32,  // DWORD
        pcbNeeded: *mut u32,  // DWORD* out
        pcReturned: *mut u32  // DWORD* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("winspool.drv", CharSet = CharSet.Unicode)]
public static extern bool EnumPortsW([MarshalAs(UnmanagedType.LPWStr)] string pName, uint Level, IntPtr pPort, uint cbBuf, out uint pcbNeeded, out uint pcReturned);
"@
$api = Add-Type -MemberDefinition $sig -Name 'winspool.drv_EnumPortsW' -Namespace Win32 -PassThru
# $api::EnumPortsW(pName, Level, pPort, cbBuf, pcbNeeded, pcReturned)
#uselib "winspool.drv"
#func global EnumPortsW "EnumPortsW" wptr, wptr, wptr, wptr, wptr, wptr
; EnumPortsW pName, Level, varptr(pPort), cbBuf, varptr(pcbNeeded), varptr(pcReturned)   ; 戻り値は stat
; pName : LPWSTR optional -> "wptr"
; Level : DWORD -> "wptr"
; pPort : BYTE* optional, out -> "wptr"
; cbBuf : DWORD -> "wptr"
; pcbNeeded : DWORD* out -> "wptr"
; pcReturned : DWORD* out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "winspool.drv"
#cfunc global EnumPortsW "EnumPortsW" wstr, int, var, int, var, var
; res = EnumPortsW(pName, Level, pPort, cbBuf, pcbNeeded, pcReturned)
; pName : LPWSTR optional -> "wstr"
; Level : DWORD -> "int"
; pPort : BYTE* optional, out -> "var"
; cbBuf : DWORD -> "int"
; pcbNeeded : DWORD* out -> "var"
; pcReturned : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL EnumPortsW(LPWSTR pName, DWORD Level, BYTE* pPort, DWORD cbBuf, DWORD* pcbNeeded, DWORD* pcReturned)
#uselib "winspool.drv"
#cfunc global EnumPortsW "EnumPortsW" wstr, int, var, int, var, var
; res = EnumPortsW(pName, Level, pPort, cbBuf, pcbNeeded, pcReturned)
; pName : LPWSTR optional -> "wstr"
; Level : DWORD -> "int"
; pPort : BYTE* optional, out -> "var"
; cbBuf : DWORD -> "int"
; pcbNeeded : DWORD* out -> "var"
; pcReturned : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	winspool_drv = windows.NewLazySystemDLL("winspool.drv")
	procEnumPortsW = winspool_drv.NewProc("EnumPortsW")
)

// pName (LPWSTR optional), Level (DWORD), pPort (BYTE* optional, out), cbBuf (DWORD), pcbNeeded (DWORD* out), pcReturned (DWORD* out)
r1, _, err := procEnumPortsW.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(pName))),
	uintptr(Level),
	uintptr(pPort),
	uintptr(cbBuf),
	uintptr(pcbNeeded),
	uintptr(pcReturned),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function EnumPortsW(
  pName: PWideChar;   // LPWSTR optional
  Level: DWORD;   // DWORD
  pPort: Pointer;   // BYTE* optional, out
  cbBuf: DWORD;   // DWORD
  pcbNeeded: Pointer;   // DWORD* out
  pcReturned: Pointer   // DWORD* out
): BOOL; stdcall;
  external 'winspool.drv' name 'EnumPortsW';
result := DllCall("winspool.drv\EnumPortsW"
    , "WStr", pName   ; LPWSTR optional
    , "UInt", Level   ; DWORD
    , "Ptr", pPort   ; BYTE* optional, out
    , "UInt", cbBuf   ; DWORD
    , "Ptr", pcbNeeded   ; DWORD* out
    , "Ptr", pcReturned   ; DWORD* out
    , "Int")   ; return: BOOL
●EnumPortsW(pName, Level, pPort, cbBuf, pcbNeeded, pcReturned) = DLL("winspool.drv", "bool EnumPortsW(char*, dword, void*, dword, void*, void*)")
# 呼び出し: EnumPortsW(pName, Level, pPort, cbBuf, pcbNeeded, pcReturned)
# pName : LPWSTR optional -> "char*"
# Level : DWORD -> "dword"
# pPort : BYTE* optional, out -> "void*"
# cbBuf : DWORD -> "dword"
# pcbNeeded : DWORD* out -> "void*"
# pcReturned : DWORD* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。