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

EnumPrinterDataExA

関数
指定キー配下のプリンタ構成データ値を列挙する(ANSI版)。
DLLwinspool.drv文字セットANSI (-A)呼出規約winapi
📘 Microsoft Learn (日本語) · English

シグネチャ

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

DWORD EnumPrinterDataExA(
    PRINTER_HANDLE hPrinter,
    LPCSTR pKeyName,
    BYTE* pEnumValues,   // optional
    DWORD cbEnumValues,
    DWORD* pcbEnumValues,
    DWORD* pnEnumValues
);

パラメーター

名前型方向説明
hPrinterPRINTER_HANDLEin設定値を列挙する対象プリンターのハンドル。
pKeyNameLPCSTRin列挙対象のレジストリキーのパスを指すポインタ。
pEnumValuesBYTE*outoptional列挙結果を受け取るPRINTER_ENUM_VALUES配列用バッファへのポインタ。
cbEnumValuesDWORDinpEnumValuesバッファのサイズ(バイト単位)。
pcbEnumValuesDWORD*out必要なバイト数を受け取る変数へのポインタ。
pnEnumValuesDWORD*out列挙された値の数を受け取る変数へのポインタ。

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD EnumPrinterDataExA(
    PRINTER_HANDLE hPrinter,
    LPCSTR pKeyName,
    BYTE* pEnumValues,   // optional
    DWORD cbEnumValues,
    DWORD* pcbEnumValues,
    DWORD* pnEnumValues
);
[DllImport("winspool.drv", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint EnumPrinterDataExA(
    PRINTER_HANDLE hPrinter,   // PRINTER_HANDLE
    [MarshalAs(UnmanagedType.LPStr)] string pKeyName,   // LPCSTR
    IntPtr pEnumValues,   // BYTE* optional, out
    uint cbEnumValues,   // DWORD
    out uint pcbEnumValues,   // DWORD* out
    out uint pnEnumValues   // DWORD* out
);
<DllImport("winspool.drv", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function EnumPrinterDataExA(
    hPrinter As PRINTER_HANDLE,   ' PRINTER_HANDLE
    <MarshalAs(UnmanagedType.LPStr)> pKeyName As String,   ' LPCSTR
    pEnumValues As IntPtr,   ' BYTE* optional, out
    cbEnumValues As UInteger,   ' DWORD
    <Out> ByRef pcbEnumValues As UInteger,   ' DWORD* out
    <Out> ByRef pnEnumValues As UInteger   ' DWORD* out
) As UInteger
End Function
' hPrinter : PRINTER_HANDLE
' pKeyName : LPCSTR
' pEnumValues : BYTE* optional, out
' cbEnumValues : DWORD
' pcbEnumValues : DWORD* out
' pnEnumValues : DWORD* out
Declare PtrSafe Function EnumPrinterDataExA Lib "winspool.drv" ( _
    ByVal hPrinter As LongPtr, _
    ByVal pKeyName As String, _
    ByVal pEnumValues As LongPtr, _
    ByVal cbEnumValues As Long, _
    ByRef pcbEnumValues As Long, _
    ByRef pnEnumValues As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

EnumPrinterDataExA = ctypes.windll.LoadLibrary("winspool.drv").EnumPrinterDataExA
EnumPrinterDataExA.restype = wintypes.DWORD
EnumPrinterDataExA.argtypes = [
    PRINTER_HANDLE,  # hPrinter : PRINTER_HANDLE
    wintypes.LPCSTR,  # pKeyName : LPCSTR
    ctypes.POINTER(ctypes.c_ubyte),  # pEnumValues : BYTE* optional, out
    wintypes.DWORD,  # cbEnumValues : DWORD
    ctypes.POINTER(wintypes.DWORD),  # pcbEnumValues : DWORD* out
    ctypes.POINTER(wintypes.DWORD),  # pnEnumValues : DWORD* out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('winspool.drv')
EnumPrinterDataExA = Fiddle::Function.new(
  lib['EnumPrinterDataExA'],
  [
    Fiddle::TYPE_VOIDP,  # hPrinter : PRINTER_HANDLE
    Fiddle::TYPE_VOIDP,  # pKeyName : LPCSTR
    Fiddle::TYPE_VOIDP,  # pEnumValues : BYTE* optional, out
    -Fiddle::TYPE_INT,  # cbEnumValues : DWORD
    Fiddle::TYPE_VOIDP,  # pcbEnumValues : DWORD* out
    Fiddle::TYPE_VOIDP,  # pnEnumValues : DWORD* out
  ],
  -Fiddle::TYPE_INT)
#[link(name = "winspool.drv")]
extern "system" {
    fn EnumPrinterDataExA(
        hPrinter: PRINTER_HANDLE,  // PRINTER_HANDLE
        pKeyName: *const u8,  // LPCSTR
        pEnumValues: *mut u8,  // BYTE* optional, out
        cbEnumValues: u32,  // DWORD
        pcbEnumValues: *mut u32,  // DWORD* out
        pnEnumValues: *mut u32  // DWORD* out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("winspool.drv", CharSet = CharSet.Ansi)]
public static extern uint EnumPrinterDataExA(PRINTER_HANDLE hPrinter, [MarshalAs(UnmanagedType.LPStr)] string pKeyName, IntPtr pEnumValues, uint cbEnumValues, out uint pcbEnumValues, out uint pnEnumValues);
"@
$api = Add-Type -MemberDefinition $sig -Name 'winspool.drv_EnumPrinterDataExA' -Namespace Win32 -PassThru
# $api::EnumPrinterDataExA(hPrinter, pKeyName, pEnumValues, cbEnumValues, pcbEnumValues, pnEnumValues)
#uselib "winspool.drv"
#func global EnumPrinterDataExA "EnumPrinterDataExA" sptr, sptr, sptr, sptr, sptr, sptr
; EnumPrinterDataExA hPrinter, pKeyName, varptr(pEnumValues), cbEnumValues, varptr(pcbEnumValues), varptr(pnEnumValues)   ; 戻り値は stat
; hPrinter : PRINTER_HANDLE -> "sptr"
; pKeyName : LPCSTR -> "sptr"
; pEnumValues : BYTE* optional, out -> "sptr"
; cbEnumValues : DWORD -> "sptr"
; pcbEnumValues : DWORD* out -> "sptr"
; pnEnumValues : DWORD* out -> "sptr"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数: 
#uselib "winspool.drv"
#cfunc global EnumPrinterDataExA "EnumPrinterDataExA" int, str, var, int, var, var
; res = EnumPrinterDataExA(hPrinter, pKeyName, pEnumValues, cbEnumValues, pcbEnumValues, pnEnumValues)
; hPrinter : PRINTER_HANDLE -> "int"
; pKeyName : LPCSTR -> "str"
; pEnumValues : BYTE* optional, out -> "var"
; cbEnumValues : DWORD -> "int"
; pcbEnumValues : DWORD* out -> "var"
; pnEnumValues : DWORD* out -> "var"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数: 
; DWORD EnumPrinterDataExA(PRINTER_HANDLE hPrinter, LPCSTR pKeyName, BYTE* pEnumValues, DWORD cbEnumValues, DWORD* pcbEnumValues, DWORD* pnEnumValues)
#uselib "winspool.drv"
#cfunc global EnumPrinterDataExA "EnumPrinterDataExA" int, str, var, int, var, var
; res = EnumPrinterDataExA(hPrinter, pKeyName, pEnumValues, cbEnumValues, pcbEnumValues, pnEnumValues)
; hPrinter : PRINTER_HANDLE -> "int"
; pKeyName : LPCSTR -> "str"
; pEnumValues : BYTE* optional, out -> "var"
; cbEnumValues : DWORD -> "int"
; pcbEnumValues : DWORD* out -> "var"
; pnEnumValues : DWORD* out -> "var"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	winspool_drv = windows.NewLazySystemDLL("winspool.drv")
	procEnumPrinterDataExA = winspool_drv.NewProc("EnumPrinterDataExA")
)

// hPrinter (PRINTER_HANDLE), pKeyName (LPCSTR), pEnumValues (BYTE* optional, out), cbEnumValues (DWORD), pcbEnumValues (DWORD* out), pnEnumValues (DWORD* out)
r1, _, err := procEnumPrinterDataExA.Call(
	uintptr(hPrinter),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(pKeyName))),
	uintptr(pEnumValues),
	uintptr(cbEnumValues),
	uintptr(pcbEnumValues),
	uintptr(pnEnumValues),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function EnumPrinterDataExA(
  hPrinter: PRINTER_HANDLE;   // PRINTER_HANDLE
  pKeyName: PAnsiChar;   // LPCSTR
  pEnumValues: Pointer;   // BYTE* optional, out
  cbEnumValues: DWORD;   // DWORD
  pcbEnumValues: Pointer;   // DWORD* out
  pnEnumValues: Pointer   // DWORD* out
): DWORD; stdcall;
  external 'winspool.drv' name 'EnumPrinterDataExA';
result := DllCall("winspool.drv\EnumPrinterDataExA"
    , "Ptr", hPrinter   ; PRINTER_HANDLE
    , "AStr", pKeyName   ; LPCSTR
    , "Ptr", pEnumValues   ; BYTE* optional, out
    , "UInt", cbEnumValues   ; DWORD
    , "Ptr", pcbEnumValues   ; DWORD* out
    , "Ptr", pnEnumValues   ; DWORD* out
    , "UInt")   ; return: DWORD
●EnumPrinterDataExA(hPrinter, pKeyName, pEnumValues, cbEnumValues, pcbEnumValues, pnEnumValues) = DLL("winspool.drv", "dword EnumPrinterDataExA(void*, char*, void*, dword, void*, void*)")
# 呼び出し: EnumPrinterDataExA(hPrinter, pKeyName, pEnumValues, cbEnumValues, pcbEnumValues, pnEnumValues)
# hPrinter : PRINTER_HANDLE -> "void*"
# pKeyName : LPCSTR -> "char*"
# pEnumValues : BYTE* optional, out -> "void*"
# cbEnumValues : DWORD -> "dword"
# pcbEnumValues : DWORD* out -> "void*"
# pnEnumValues : DWORD* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef EnumPrinterDataExANative = Uint32 Function(PRINTER_HANDLE, Pointer<Utf8>, Pointer<Uint8>, Uint32, Pointer<Uint32>, Pointer<Uint32>);
typedef EnumPrinterDataExADart = int Function(int, Pointer<Utf8>, Pointer<Uint8>, int, Pointer<Uint32>, Pointer<Uint32>);
final EnumPrinterDataExA = DynamicLibrary.open('winspool.drv')
    .lookupFunction<EnumPrinterDataExANative, EnumPrinterDataExADart>('EnumPrinterDataExA');
// hPrinter : PRINTER_HANDLE -> PRINTER_HANDLE
// pKeyName : LPCSTR -> Pointer<Utf8>
// pEnumValues : BYTE* optional, out -> Pointer<Uint8>
// cbEnumValues : DWORD -> Uint32
// pcbEnumValues : DWORD* out -> Pointer<Uint32>
// pnEnumValues : DWORD* out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function EnumPrinterDataExA(
  hPrinter: PRINTER_HANDLE;   // PRINTER_HANDLE
  pKeyName: PAnsiChar;   // LPCSTR
  pEnumValues: Pointer;   // BYTE* optional, out
  cbEnumValues: DWORD;   // DWORD
  pcbEnumValues: Pointer;   // DWORD* out
  pnEnumValues: Pointer   // DWORD* out
): DWORD; stdcall;
  external 'winspool.drv' name 'EnumPrinterDataExA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "EnumPrinterDataExA"
  c_EnumPrinterDataExA :: PRINTER_HANDLE -> CString -> Ptr Word8 -> Word32 -> Ptr Word32 -> Ptr Word32 -> IO Word32
-- hPrinter : PRINTER_HANDLE -> PRINTER_HANDLE
-- pKeyName : LPCSTR -> CString
-- pEnumValues : BYTE* optional, out -> Ptr Word8
-- cbEnumValues : DWORD -> Word32
-- pcbEnumValues : DWORD* out -> Ptr Word32
-- pnEnumValues : DWORD* out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
-- ※値渡し構造体は GHC FFI で直接渡せません。Ptr で渡すラッパ(C側)経由にしてください。
open Ctypes
open Foreign

let enumprinterdataexa =
  foreign "EnumPrinterDataExA"
    (PRINTER_HANDLE @-> string @-> (ptr uint8_t) @-> uint32_t @-> (ptr uint32_t) @-> (ptr uint32_t) @-> returning uint32_t)
(* hPrinter : PRINTER_HANDLE -> PRINTER_HANDLE *)
(* pKeyName : LPCSTR -> string *)
(* pEnumValues : BYTE* optional, out -> (ptr uint8_t) *)
(* cbEnumValues : DWORD -> uint32_t *)
(* pcbEnumValues : DWORD* out -> (ptr uint32_t) *)
(* pnEnumValues : 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 ("EnumPrinterDataExA" enum-printer-data-ex-a :convention :stdcall) :uint32
  (h-printer (:struct printer-handle))   ; PRINTER_HANDLE
  (p-key-name :string)   ; LPCSTR
  (p-enum-values :pointer)   ; BYTE* optional, out
  (cb-enum-values :uint32)   ; DWORD
  (pcb-enum-values :pointer)   ; DWORD* out
  (pn-enum-values :pointer))   ; DWORD* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $EnumPrinterDataExA = Win32::API::More->new('winspool.drv',
    'DWORD EnumPrinterDataExA(LPVOID hPrinter, LPCSTR pKeyName, LPVOID pEnumValues, DWORD cbEnumValues, LPVOID pcbEnumValues, LPVOID pnEnumValues)');
# my $ret = $EnumPrinterDataExA->Call($hPrinter, $pKeyName, $pEnumValues, $cbEnumValues, $pcbEnumValues, $pnEnumValues);
# hPrinter : PRINTER_HANDLE -> LPVOID
# pKeyName : LPCSTR -> LPCSTR
# pEnumValues : BYTE* optional, out -> LPVOID
# cbEnumValues : DWORD -> DWORD
# pcbEnumValues : DWORD* out -> LPVOID
# pnEnumValues : DWORD* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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