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

EnumPortsA

関数
使用可能なプリンターポートを列挙する。
DLLwinspool.drv文字セットANSI (-A)呼出規約winapi
📘 Microsoft Learn (日本語) · English

シグネチャ

// winspool.drv  (ANSI / -A)
#include <windows.h>

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

パラメーター

名前型方向説明
pNameLPSTRinoptional列挙対象サーバー名を指すポインタ。ローカルならNULLを指定する。
LevelDWORDin取得するPORT_INFO構造体のレベル。1または2を指定する。
pPortBYTE*outoptional列挙結果を受け取るPORT_INFO_x配列用バッファへのポインタ。
cbBufDWORDinpPortバッファのサイズ(バイト単位)。
pcbNeededDWORD*out必要なバイト数を受け取る変数へのポインタ。
pcReturnedDWORD*out列挙されたポート数を受け取る変数へのポインタ。

戻り値の型: BOOL

各言語での呼び出し定義

// winspool.drv  (ANSI / -A)
#include <windows.h>

BOOL EnumPortsA(
    LPSTR pName,   // optional
    DWORD Level,
    BYTE* pPort,   // optional
    DWORD cbBuf,
    DWORD* pcbNeeded,
    DWORD* pcReturned
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("winspool.drv", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern bool EnumPortsA(
    [MarshalAs(UnmanagedType.LPStr)] string pName,   // LPSTR 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.Ansi, ExactSpelling:=True)>
Public Shared Function EnumPortsA(
    <MarshalAs(UnmanagedType.LPStr)> pName As String,   ' LPSTR 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 <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' pName : LPSTR optional
' Level : DWORD
' pPort : BYTE* optional, out
' cbBuf : DWORD
' pcbNeeded : DWORD* out
' pcReturned : DWORD* out
Declare PtrSafe Function EnumPortsA Lib "winspool.drv" ( _
    ByVal pName As String, _
    ByVal Level As Long, _
    ByVal pPort As LongPtr, _
    ByVal cbBuf As Long, _
    ByRef pcbNeeded As Long, _
    ByRef pcReturned As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

EnumPortsA = ctypes.windll.LoadLibrary("winspool.drv").EnumPortsA
EnumPortsA.restype = wintypes.BOOL
EnumPortsA.argtypes = [
    wintypes.LPCSTR,  # pName : LPSTR 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')
EnumPortsA = Fiddle::Function.new(
  lib['EnumPortsA'],
  [
    Fiddle::TYPE_VOIDP,  # pName : LPSTR 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)
#[link(name = "winspool.drv")]
extern "system" {
    fn EnumPortsA(
        pName: *mut u8,  // LPSTR 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.Ansi)]
public static extern bool EnumPortsA([MarshalAs(UnmanagedType.LPStr)] string pName, uint Level, IntPtr pPort, uint cbBuf, out uint pcbNeeded, out uint pcReturned);
"@
$api = Add-Type -MemberDefinition $sig -Name 'winspool.drv_EnumPortsA' -Namespace Win32 -PassThru
# $api::EnumPortsA(pName, Level, pPort, cbBuf, pcbNeeded, pcReturned)
#uselib "winspool.drv"
#func global EnumPortsA "EnumPortsA" sptr, sptr, sptr, sptr, sptr, sptr
; EnumPortsA pName, Level, varptr(pPort), cbBuf, varptr(pcbNeeded), varptr(pcReturned)   ; 戻り値は stat
; pName : LPSTR optional -> "sptr"
; Level : DWORD -> "sptr"
; pPort : BYTE* optional, out -> "sptr"
; cbBuf : DWORD -> "sptr"
; pcbNeeded : DWORD* out -> "sptr"
; pcReturned : DWORD* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数: 
#uselib "winspool.drv"
#cfunc global EnumPortsA "EnumPortsA" str, int, var, int, var, var
; res = EnumPortsA(pName, Level, pPort, cbBuf, pcbNeeded, pcReturned)
; pName : LPSTR optional -> "str"
; Level : DWORD -> "int"
; pPort : BYTE* optional, out -> "var"
; cbBuf : DWORD -> "int"
; pcbNeeded : DWORD* out -> "var"
; pcReturned : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数: 
; BOOL EnumPortsA(LPSTR pName, DWORD Level, BYTE* pPort, DWORD cbBuf, DWORD* pcbNeeded, DWORD* pcReturned)
#uselib "winspool.drv"
#cfunc global EnumPortsA "EnumPortsA" str, int, var, int, var, var
; res = EnumPortsA(pName, Level, pPort, cbBuf, pcbNeeded, pcReturned)
; pName : LPSTR optional -> "str"
; 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")
	procEnumPortsA = winspool_drv.NewProc("EnumPortsA")
)

// pName (LPSTR optional), Level (DWORD), pPort (BYTE* optional, out), cbBuf (DWORD), pcbNeeded (DWORD* out), pcReturned (DWORD* out)
r1, _, err := procEnumPortsA.Call(
	uintptr(unsafe.Pointer(windows.BytePtrFromString(pName))),
	uintptr(Level),
	uintptr(pPort),
	uintptr(cbBuf),
	uintptr(pcbNeeded),
	uintptr(pcReturned),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function EnumPortsA(
  pName: PAnsiChar;   // LPSTR 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 'EnumPortsA';
result := DllCall("winspool.drv\EnumPortsA"
    , "AStr", pName   ; LPSTR optional
    , "UInt", Level   ; DWORD
    , "Ptr", pPort   ; BYTE* optional, out
    , "UInt", cbBuf   ; DWORD
    , "Ptr", pcbNeeded   ; DWORD* out
    , "Ptr", pcReturned   ; DWORD* out
    , "Int")   ; return: BOOL
●EnumPortsA(pName, Level, pPort, cbBuf, pcbNeeded, pcReturned) = DLL("winspool.drv", "bool EnumPortsA(char*, dword, void*, dword, void*, void*)")
# 呼び出し: EnumPortsA(pName, Level, pPort, cbBuf, pcbNeeded, pcReturned)
# pName : LPSTR 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)。
const std = @import("std");

extern "winspool.drv" fn EnumPortsA(
    pName: [*c]const u8, // LPSTR optional
    Level: u32, // DWORD
    pPort: [*c]u8, // BYTE* optional, out
    cbBuf: u32, // DWORD
    pcbNeeded: [*c]u32, // DWORD* out
    pcReturned: [*c]u32 // DWORD* out
) callconv(std.os.windows.WINAPI) i32;
proc EnumPortsA(
    pName: cstring,  # LPSTR optional
    Level: uint32,  # DWORD
    pPort: ptr uint8,  # BYTE* optional, out
    cbBuf: uint32,  # DWORD
    pcbNeeded: ptr uint32,  # DWORD* out
    pcReturned: ptr uint32  # DWORD* out
): int32 {.importc: "EnumPortsA", stdcall, dynlib: "winspool.drv".}
pragma(lib, "winspool.drv");
extern(Windows)
int EnumPortsA(
    const(char)* pName,   // LPSTR optional
    uint Level,   // DWORD
    ubyte* pPort,   // BYTE* optional, out
    uint cbBuf,   // DWORD
    uint* pcbNeeded,   // DWORD* out
    uint* pcReturned   // DWORD* out
);
ccall((:EnumPortsA, "winspool.drv"), stdcall, Int32,
      (Cstring, UInt32, Ptr{UInt8}, UInt32, Ptr{UInt32}, Ptr{UInt32}),
      pName, Level, pPort, cbBuf, pcbNeeded, pcReturned)
# pName : LPSTR optional -> Cstring
# Level : DWORD -> UInt32
# pPort : BYTE* optional, out -> Ptr{UInt8}
# cbBuf : DWORD -> UInt32
# pcbNeeded : DWORD* out -> Ptr{UInt32}
# pcReturned : DWORD* out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t EnumPortsA(
    const char* pName,
    uint32_t Level,
    uint8_t* pPort,
    uint32_t cbBuf,
    uint32_t* pcbNeeded,
    uint32_t* pcReturned);
]]
local winspool.drv = ffi.load("winspool.drv")
-- winspool.drv.EnumPortsA(pName, Level, pPort, cbBuf, pcbNeeded, pcReturned)
-- pName : LPSTR optional
-- Level : DWORD
-- pPort : BYTE* optional, out
-- cbBuf : DWORD
-- pcbNeeded : DWORD* out
-- pcReturned : DWORD* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('winspool.drv');
const EnumPortsA = lib.func('__stdcall', 'EnumPortsA', 'int32_t', ['str', 'uint32_t', 'uint8_t *', 'uint32_t', 'uint32_t *', 'uint32_t *']);
// EnumPortsA(pName, Level, pPort, cbBuf, pcbNeeded, pcReturned)
// pName : LPSTR optional -> 'str'
// Level : DWORD -> 'uint32_t'
// pPort : BYTE* optional, out -> 'uint8_t *'
// cbBuf : DWORD -> 'uint32_t'
// pcbNeeded : DWORD* out -> 'uint32_t *'
// pcReturned : DWORD* out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("winspool.drv", {
  EnumPortsA: { parameters: ["buffer", "u32", "pointer", "u32", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.EnumPortsA(pName, Level, pPort, cbBuf, pcbNeeded, pcReturned)
// pName : LPSTR optional -> "buffer"
// Level : DWORD -> "u32"
// pPort : BYTE* optional, out -> "pointer"
// cbBuf : DWORD -> "u32"
// pcbNeeded : DWORD* out -> "pointer"
// pcReturned : DWORD* out -> "pointer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t EnumPortsA(
    const char* pName,
    uint32_t Level,
    uint8_t* pPort,
    uint32_t cbBuf,
    uint32_t* pcbNeeded,
    uint32_t* pcReturned);
C, "winspool.drv");
// $ffi->EnumPortsA(pName, Level, pPort, cbBuf, pcbNeeded, pcReturned);
// pName : LPSTR optional
// Level : DWORD
// pPort : BYTE* optional, out
// cbBuf : DWORD
// pcbNeeded : DWORD* out
// pcReturned : DWORD* 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 Winspool.drv extends StdCallLibrary {
    Winspool.drv INSTANCE = Native.load("winspool.drv", Winspool.drv.class, W32APIOptions.ASCII_OPTIONS);
    boolean EnumPortsA(
        String pName,   // LPSTR optional
        int Level,   // DWORD
        byte[] pPort,   // BYTE* optional, out
        int cbBuf,   // DWORD
        IntByReference pcbNeeded,   // DWORD* out
        IntByReference pcReturned   // DWORD* out
    );
}
@[Link("winspool.drv")]
lib Libwinspool.drv
  fun EnumPortsA = EnumPortsA(
    pName : UInt8*,   # LPSTR optional
    Level : UInt32,   # DWORD
    pPort : UInt8*,   # BYTE* optional, out
    cbBuf : UInt32,   # DWORD
    pcbNeeded : UInt32*,   # DWORD* out
    pcReturned : UInt32*   # DWORD* out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef EnumPortsANative = Int32 Function(Pointer<Utf8>, Uint32, Pointer<Uint8>, Uint32, Pointer<Uint32>, Pointer<Uint32>);
typedef EnumPortsADart = int Function(Pointer<Utf8>, int, Pointer<Uint8>, int, Pointer<Uint32>, Pointer<Uint32>);
final EnumPortsA = DynamicLibrary.open('winspool.drv')
    .lookupFunction<EnumPortsANative, EnumPortsADart>('EnumPortsA');
// pName : LPSTR optional -> Pointer<Utf8>
// Level : DWORD -> Uint32
// pPort : BYTE* optional, out -> Pointer<Uint8>
// cbBuf : DWORD -> Uint32
// pcbNeeded : DWORD* out -> Pointer<Uint32>
// pcReturned : DWORD* out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function EnumPortsA(
  pName: PAnsiChar;   // LPSTR 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 'EnumPortsA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "EnumPortsA"
  c_EnumPortsA :: CString -> Word32 -> Ptr Word8 -> Word32 -> Ptr Word32 -> Ptr Word32 -> IO CInt
-- pName : LPSTR optional -> CString
-- Level : DWORD -> Word32
-- pPort : BYTE* optional, out -> Ptr Word8
-- cbBuf : DWORD -> Word32
-- pcbNeeded : DWORD* out -> Ptr Word32
-- pcReturned : DWORD* out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let enumportsa =
  foreign "EnumPortsA"
    (string @-> uint32_t @-> (ptr uint8_t) @-> uint32_t @-> (ptr uint32_t) @-> (ptr uint32_t) @-> returning int32_t)
(* pName : LPSTR optional -> string *)
(* Level : DWORD -> uint32_t *)
(* pPort : BYTE* optional, out -> (ptr uint8_t) *)
(* cbBuf : DWORD -> uint32_t *)
(* pcbNeeded : DWORD* out -> (ptr uint32_t) *)
(* pcReturned : DWORD* out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library winspool.drv (t "winspool.drv"))
(cffi:use-foreign-library winspool.drv)

(cffi:defcfun ("EnumPortsA" enum-ports-a :convention :stdcall) :int32
  (p-name :string)   ; LPSTR optional
  (level :uint32)   ; DWORD
  (p-port :pointer)   ; BYTE* optional, out
  (cb-buf :uint32)   ; DWORD
  (pcb-needed :pointer)   ; DWORD* out
  (pc-returned :pointer))   ; DWORD* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $EnumPortsA = Win32::API::More->new('winspool.drv',
    'BOOL EnumPortsA(LPCSTR pName, DWORD Level, LPVOID pPort, DWORD cbBuf, LPVOID pcbNeeded, LPVOID pcReturned)');
# my $ret = $EnumPortsA->Call($pName, $Level, $pPort, $cbBuf, $pcbNeeded, $pcReturned);
# pName : LPSTR optional -> LPCSTR
# Level : DWORD -> DWORD
# pPort : BYTE* optional, out -> LPVOID
# cbBuf : DWORD -> DWORD
# pcbNeeded : DWORD* out -> LPVOID
# pcReturned : DWORD* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い