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

EnumPrintersA

関数
利用可能なプリンタを列挙する(ANSI版)。
DLLwinspool.drv文字セットANSI (-A)呼出規約winapiSetLastErrorあり

シグネチャ

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

BOOL EnumPrintersA(
    DWORD Flags,
    LPCSTR Name,   // optional
    DWORD Level,
    BYTE* pPrinterEnum,   // optional
    DWORD cbBuf,
    DWORD* pcbNeeded,
    DWORD* pcReturned
);

パラメーター

名前方向
FlagsDWORDin
NameLPCSTRinoptional
LevelDWORDin
pPrinterEnumBYTE*outoptional
cbBufDWORDin
pcbNeededDWORD*out
pcReturnedDWORD*out

戻り値の型: BOOL

各言語での呼び出し定義

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

BOOL EnumPrintersA(
    DWORD Flags,
    LPCSTR Name,   // optional
    DWORD Level,
    BYTE* pPrinterEnum,   // optional
    DWORD cbBuf,
    DWORD* pcbNeeded,
    DWORD* pcReturned
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("winspool.drv", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool EnumPrintersA(
    uint Flags,   // DWORD
    [MarshalAs(UnmanagedType.LPStr)] string Name,   // LPCSTR optional
    uint Level,   // DWORD
    IntPtr pPrinterEnum,   // BYTE* optional, out
    uint cbBuf,   // DWORD
    out uint pcbNeeded,   // DWORD* out
    out uint pcReturned   // DWORD* out
);
<DllImport("winspool.drv", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function EnumPrintersA(
    Flags As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPStr)> Name As String,   ' LPCSTR optional
    Level As UInteger,   ' DWORD
    pPrinterEnum 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
' Flags : DWORD
' Name : LPCSTR optional
' Level : DWORD
' pPrinterEnum : BYTE* optional, out
' cbBuf : DWORD
' pcbNeeded : DWORD* out
' pcReturned : DWORD* out
Declare PtrSafe Function EnumPrintersA Lib "winspool.drv" ( _
    ByVal Flags As Long, _
    ByVal Name As String, _
    ByVal Level As Long, _
    ByVal pPrinterEnum 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

EnumPrintersA = ctypes.windll.LoadLibrary("winspool.drv").EnumPrintersA
EnumPrintersA.restype = wintypes.BOOL
EnumPrintersA.argtypes = [
    wintypes.DWORD,  # Flags : DWORD
    wintypes.LPCSTR,  # Name : LPCSTR optional
    wintypes.DWORD,  # Level : DWORD
    ctypes.POINTER(ctypes.c_ubyte),  # pPrinterEnum : BYTE* optional, out
    wintypes.DWORD,  # cbBuf : DWORD
    ctypes.POINTER(wintypes.DWORD),  # pcbNeeded : DWORD* out
    ctypes.POINTER(wintypes.DWORD),  # pcReturned : DWORD* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('winspool.drv')
EnumPrintersA = Fiddle::Function.new(
  lib['EnumPrintersA'],
  [
    -Fiddle::TYPE_INT,  # Flags : DWORD
    Fiddle::TYPE_VOIDP,  # Name : LPCSTR optional
    -Fiddle::TYPE_INT,  # Level : DWORD
    Fiddle::TYPE_VOIDP,  # pPrinterEnum : 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 EnumPrintersA(
        Flags: u32,  // DWORD
        Name: *const u8,  // LPCSTR optional
        Level: u32,  // DWORD
        pPrinterEnum: *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, SetLastError = true)]
public static extern bool EnumPrintersA(uint Flags, [MarshalAs(UnmanagedType.LPStr)] string Name, uint Level, IntPtr pPrinterEnum, uint cbBuf, out uint pcbNeeded, out uint pcReturned);
"@
$api = Add-Type -MemberDefinition $sig -Name 'winspool.drv_EnumPrintersA' -Namespace Win32 -PassThru
# $api::EnumPrintersA(Flags, Name, Level, pPrinterEnum, cbBuf, pcbNeeded, pcReturned)
#uselib "winspool.drv"
#func global EnumPrintersA "EnumPrintersA" sptr, sptr, sptr, sptr, sptr, sptr, sptr
; EnumPrintersA Flags, Name, Level, varptr(pPrinterEnum), cbBuf, varptr(pcbNeeded), varptr(pcReturned)   ; 戻り値は stat
; Flags : DWORD -> "sptr"
; Name : LPCSTR optional -> "sptr"
; Level : DWORD -> "sptr"
; pPrinterEnum : BYTE* optional, out -> "sptr"
; cbBuf : DWORD -> "sptr"
; pcbNeeded : DWORD* out -> "sptr"
; pcReturned : DWORD* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "winspool.drv"
#cfunc global EnumPrintersA "EnumPrintersA" int, str, int, var, int, var, var
; res = EnumPrintersA(Flags, Name, Level, pPrinterEnum, cbBuf, pcbNeeded, pcReturned)
; Flags : DWORD -> "int"
; Name : LPCSTR optional -> "str"
; Level : DWORD -> "int"
; pPrinterEnum : BYTE* optional, out -> "var"
; cbBuf : DWORD -> "int"
; pcbNeeded : DWORD* out -> "var"
; pcReturned : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL EnumPrintersA(DWORD Flags, LPCSTR Name, DWORD Level, BYTE* pPrinterEnum, DWORD cbBuf, DWORD* pcbNeeded, DWORD* pcReturned)
#uselib "winspool.drv"
#cfunc global EnumPrintersA "EnumPrintersA" int, str, int, var, int, var, var
; res = EnumPrintersA(Flags, Name, Level, pPrinterEnum, cbBuf, pcbNeeded, pcReturned)
; Flags : DWORD -> "int"
; Name : LPCSTR optional -> "str"
; Level : DWORD -> "int"
; pPrinterEnum : 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")
	procEnumPrintersA = winspool_drv.NewProc("EnumPrintersA")
)

// Flags (DWORD), Name (LPCSTR optional), Level (DWORD), pPrinterEnum (BYTE* optional, out), cbBuf (DWORD), pcbNeeded (DWORD* out), pcReturned (DWORD* out)
r1, _, err := procEnumPrintersA.Call(
	uintptr(Flags),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(Name))),
	uintptr(Level),
	uintptr(pPrinterEnum),
	uintptr(cbBuf),
	uintptr(pcbNeeded),
	uintptr(pcReturned),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function EnumPrintersA(
  Flags: DWORD;   // DWORD
  Name: PAnsiChar;   // LPCSTR optional
  Level: DWORD;   // DWORD
  pPrinterEnum: Pointer;   // BYTE* optional, out
  cbBuf: DWORD;   // DWORD
  pcbNeeded: Pointer;   // DWORD* out
  pcReturned: Pointer   // DWORD* out
): BOOL; stdcall;
  external 'winspool.drv' name 'EnumPrintersA';
result := DllCall("winspool.drv\EnumPrintersA"
    , "UInt", Flags   ; DWORD
    , "AStr", Name   ; LPCSTR optional
    , "UInt", Level   ; DWORD
    , "Ptr", pPrinterEnum   ; BYTE* optional, out
    , "UInt", cbBuf   ; DWORD
    , "Ptr", pcbNeeded   ; DWORD* out
    , "Ptr", pcReturned   ; DWORD* out
    , "Int")   ; return: BOOL
●EnumPrintersA(Flags, Name, Level, pPrinterEnum, cbBuf, pcbNeeded, pcReturned) = DLL("winspool.drv", "bool EnumPrintersA(dword, char*, dword, void*, dword, void*, void*)")
# 呼び出し: EnumPrintersA(Flags, Name, Level, pPrinterEnum, cbBuf, pcbNeeded, pcReturned)
# Flags : DWORD -> "dword"
# Name : LPCSTR optional -> "char*"
# Level : DWORD -> "dword"
# pPrinterEnum : BYTE* optional, out -> "void*"
# cbBuf : DWORD -> "dword"
# pcbNeeded : DWORD* out -> "void*"
# pcReturned : DWORD* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。