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

EnumPrinterKeyW

関数
プリンタ構成データのサブキーを列挙する(Unicode版)。
DLLwinspool.drv文字セットUnicode (-W)呼出規約winapi

シグネチャ

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

DWORD EnumPrinterKeyW(
    PRINTER_HANDLE hPrinter,
    LPCWSTR pKeyName,
    LPWSTR pSubkey,   // optional
    DWORD cbSubkey,
    DWORD* pcbSubkey
);

パラメーター

名前方向説明
hPrinterPRINTER_HANDLEinサブキーを列挙する対象プリンターのハンドル。
pKeyNameLPCWSTRin列挙の基点となるレジストリキーのパスを指すポインタ。
pSubkeyLPWSTRoutoptionalサブキー名(NULL区切りの複数文字列)を受け取るバッファへのポインタ。
cbSubkeyDWORDinpSubkeyバッファのサイズ(バイト単位)。
pcbSubkeyDWORD*out必要なバイト数を受け取る変数へのポインタ。

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD EnumPrinterKeyW(
    PRINTER_HANDLE hPrinter,
    LPCWSTR pKeyName,
    LPWSTR pSubkey,   // optional
    DWORD cbSubkey,
    DWORD* pcbSubkey
);
[DllImport("winspool.drv", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint EnumPrinterKeyW(
    PRINTER_HANDLE hPrinter,   // PRINTER_HANDLE
    [MarshalAs(UnmanagedType.LPWStr)] string pKeyName,   // LPCWSTR
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pSubkey,   // LPWSTR optional, out
    uint cbSubkey,   // DWORD
    out uint pcbSubkey   // DWORD* out
);
<DllImport("winspool.drv", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function EnumPrinterKeyW(
    hPrinter As PRINTER_HANDLE,   ' PRINTER_HANDLE
    <MarshalAs(UnmanagedType.LPWStr)> pKeyName As String,   ' LPCWSTR
    <MarshalAs(UnmanagedType.LPWStr)> pSubkey As System.Text.StringBuilder,   ' LPWSTR optional, out
    cbSubkey As UInteger,   ' DWORD
    <Out> ByRef pcbSubkey As UInteger   ' DWORD* out
) As UInteger
End Function
' hPrinter : PRINTER_HANDLE
' pKeyName : LPCWSTR
' pSubkey : LPWSTR optional, out
' cbSubkey : DWORD
' pcbSubkey : DWORD* out
Declare PtrSafe Function EnumPrinterKeyW Lib "winspool.drv" ( _
    ByVal hPrinter As LongPtr, _
    ByVal pKeyName As LongPtr, _
    ByVal pSubkey As LongPtr, _
    ByVal cbSubkey As Long, _
    ByRef pcbSubkey 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

EnumPrinterKeyW = ctypes.windll.LoadLibrary("winspool.drv").EnumPrinterKeyW
EnumPrinterKeyW.restype = wintypes.DWORD
EnumPrinterKeyW.argtypes = [
    PRINTER_HANDLE,  # hPrinter : PRINTER_HANDLE
    wintypes.LPCWSTR,  # pKeyName : LPCWSTR
    wintypes.LPWSTR,  # pSubkey : LPWSTR optional, out
    wintypes.DWORD,  # cbSubkey : DWORD
    ctypes.POINTER(wintypes.DWORD),  # pcbSubkey : DWORD* out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('winspool.drv')
EnumPrinterKeyW = Fiddle::Function.new(
  lib['EnumPrinterKeyW'],
  [
    Fiddle::TYPE_VOIDP,  # hPrinter : PRINTER_HANDLE
    Fiddle::TYPE_VOIDP,  # pKeyName : LPCWSTR
    Fiddle::TYPE_VOIDP,  # pSubkey : LPWSTR optional, out
    -Fiddle::TYPE_INT,  # cbSubkey : DWORD
    Fiddle::TYPE_VOIDP,  # pcbSubkey : DWORD* out
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "winspool.drv")]
extern "system" {
    fn EnumPrinterKeyW(
        hPrinter: PRINTER_HANDLE,  // PRINTER_HANDLE
        pKeyName: *const u16,  // LPCWSTR
        pSubkey: *mut u16,  // LPWSTR optional, out
        cbSubkey: u32,  // DWORD
        pcbSubkey: *mut u32  // DWORD* out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("winspool.drv", CharSet = CharSet.Unicode)]
public static extern uint EnumPrinterKeyW(PRINTER_HANDLE hPrinter, [MarshalAs(UnmanagedType.LPWStr)] string pKeyName, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pSubkey, uint cbSubkey, out uint pcbSubkey);
"@
$api = Add-Type -MemberDefinition $sig -Name 'winspool.drv_EnumPrinterKeyW' -Namespace Win32 -PassThru
# $api::EnumPrinterKeyW(hPrinter, pKeyName, pSubkey, cbSubkey, pcbSubkey)
#uselib "winspool.drv"
#func global EnumPrinterKeyW "EnumPrinterKeyW" wptr, wptr, wptr, wptr, wptr
; EnumPrinterKeyW hPrinter, pKeyName, varptr(pSubkey), cbSubkey, varptr(pcbSubkey)   ; 戻り値は stat
; hPrinter : PRINTER_HANDLE -> "wptr"
; pKeyName : LPCWSTR -> "wptr"
; pSubkey : LPWSTR optional, out -> "wptr"
; cbSubkey : DWORD -> "wptr"
; pcbSubkey : DWORD* out -> "wptr"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "winspool.drv"
#cfunc global EnumPrinterKeyW "EnumPrinterKeyW" int, wstr, var, int, var
; res = EnumPrinterKeyW(hPrinter, pKeyName, pSubkey, cbSubkey, pcbSubkey)
; hPrinter : PRINTER_HANDLE -> "int"
; pKeyName : LPCWSTR -> "wstr"
; pSubkey : LPWSTR optional, out -> "var"
; cbSubkey : DWORD -> "int"
; pcbSubkey : DWORD* out -> "var"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DWORD EnumPrinterKeyW(PRINTER_HANDLE hPrinter, LPCWSTR pKeyName, LPWSTR pSubkey, DWORD cbSubkey, DWORD* pcbSubkey)
#uselib "winspool.drv"
#cfunc global EnumPrinterKeyW "EnumPrinterKeyW" int, wstr, var, int, var
; res = EnumPrinterKeyW(hPrinter, pKeyName, pSubkey, cbSubkey, pcbSubkey)
; hPrinter : PRINTER_HANDLE -> "int"
; pKeyName : LPCWSTR -> "wstr"
; pSubkey : LPWSTR optional, out -> "var"
; cbSubkey : DWORD -> "int"
; pcbSubkey : DWORD* out -> "var"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	winspool_drv = windows.NewLazySystemDLL("winspool.drv")
	procEnumPrinterKeyW = winspool_drv.NewProc("EnumPrinterKeyW")
)

// hPrinter (PRINTER_HANDLE), pKeyName (LPCWSTR), pSubkey (LPWSTR optional, out), cbSubkey (DWORD), pcbSubkey (DWORD* out)
r1, _, err := procEnumPrinterKeyW.Call(
	uintptr(hPrinter),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(pKeyName))),
	uintptr(pSubkey),
	uintptr(cbSubkey),
	uintptr(pcbSubkey),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function EnumPrinterKeyW(
  hPrinter: PRINTER_HANDLE;   // PRINTER_HANDLE
  pKeyName: PWideChar;   // LPCWSTR
  pSubkey: PWideChar;   // LPWSTR optional, out
  cbSubkey: DWORD;   // DWORD
  pcbSubkey: Pointer   // DWORD* out
): DWORD; stdcall;
  external 'winspool.drv' name 'EnumPrinterKeyW';
result := DllCall("winspool.drv\EnumPrinterKeyW"
    , "Ptr", hPrinter   ; PRINTER_HANDLE
    , "WStr", pKeyName   ; LPCWSTR
    , "Ptr", pSubkey   ; LPWSTR optional, out
    , "UInt", cbSubkey   ; DWORD
    , "Ptr", pcbSubkey   ; DWORD* out
    , "UInt")   ; return: DWORD
●EnumPrinterKeyW(hPrinter, pKeyName, pSubkey, cbSubkey, pcbSubkey) = DLL("winspool.drv", "dword EnumPrinterKeyW(void*, char*, char*, dword, void*)")
# 呼び出し: EnumPrinterKeyW(hPrinter, pKeyName, pSubkey, cbSubkey, pcbSubkey)
# hPrinter : PRINTER_HANDLE -> "void*"
# pKeyName : LPCWSTR -> "char*"
# pSubkey : LPWSTR optional, out -> "char*"
# cbSubkey : DWORD -> "dword"
# pcbSubkey : DWORD* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "winspool.drv" fn EnumPrinterKeyW(
    hPrinter: PRINTER_HANDLE, // PRINTER_HANDLE
    pKeyName: [*c]const u16, // LPCWSTR
    pSubkey: [*c]u16, // LPWSTR optional, out
    cbSubkey: u32, // DWORD
    pcbSubkey: [*c]u32 // DWORD* out
) callconv(std.os.windows.WINAPI) u32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc EnumPrinterKeyW(
    hPrinter: PRINTER_HANDLE,  # PRINTER_HANDLE
    pKeyName: WideCString,  # LPCWSTR
    pSubkey: ptr uint16,  # LPWSTR optional, out
    cbSubkey: uint32,  # DWORD
    pcbSubkey: ptr uint32  # DWORD* out
): uint32 {.importc: "EnumPrinterKeyW", stdcall, dynlib: "winspool.drv".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "winspool.drv");
extern(Windows)
uint EnumPrinterKeyW(
    PRINTER_HANDLE hPrinter,   // PRINTER_HANDLE
    const(wchar)* pKeyName,   // LPCWSTR
    wchar* pSubkey,   // LPWSTR optional, out
    uint cbSubkey,   // DWORD
    uint* pcbSubkey   // DWORD* out
);
ccall((:EnumPrinterKeyW, "winspool.drv"), stdcall, UInt32,
      (PRINTER_HANDLE, Cwstring, Ptr{UInt16}, UInt32, Ptr{UInt32}),
      hPrinter, pKeyName, pSubkey, cbSubkey, pcbSubkey)
# hPrinter : PRINTER_HANDLE -> PRINTER_HANDLE
# pKeyName : LPCWSTR -> Cwstring
# pSubkey : LPWSTR optional, out -> Ptr{UInt16}
# cbSubkey : DWORD -> UInt32
# pcbSubkey : DWORD* out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
uint32_t EnumPrinterKeyW(
    PRINTER_HANDLE hPrinter,
    const uint16_t* pKeyName,
    uint16_t* pSubkey,
    uint32_t cbSubkey,
    uint32_t* pcbSubkey);
]]
local winspool.drv = ffi.load("winspool.drv")
-- winspool.drv.EnumPrinterKeyW(hPrinter, pKeyName, pSubkey, cbSubkey, pcbSubkey)
-- hPrinter : PRINTER_HANDLE
-- pKeyName : LPCWSTR
-- pSubkey : LPWSTR optional, out
-- cbSubkey : DWORD
-- pcbSubkey : DWORD* 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('winspool.drv');
const EnumPrinterKeyW = lib.func('__stdcall', 'EnumPrinterKeyW', 'uint32_t', ['PRINTER_HANDLE', 'str16', 'uint16_t *', 'uint32_t', 'uint32_t *']);
// EnumPrinterKeyW(hPrinter, pKeyName, pSubkey, cbSubkey, pcbSubkey)
// hPrinter : PRINTER_HANDLE -> 'PRINTER_HANDLE'
// pKeyName : LPCWSTR -> 'str16'
// pSubkey : LPWSTR optional, out -> 'uint16_t *'
// cbSubkey : DWORD -> 'uint32_t'
// pcbSubkey : DWORD* out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("winspool.drv", {
  EnumPrinterKeyW: { parameters: ["buffer", "buffer", "buffer", "u32", "pointer"], result: "u32" },
});
// lib.symbols.EnumPrinterKeyW(hPrinter, pKeyName, pSubkey, cbSubkey, pcbSubkey)
// hPrinter : PRINTER_HANDLE -> "buffer"
// pKeyName : LPCWSTR -> "buffer"
// pSubkey : LPWSTR optional, out -> "buffer"
// cbSubkey : DWORD -> "u32"
// pcbSubkey : DWORD* out -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t EnumPrinterKeyW(
    PRINTER_HANDLE hPrinter,
    const uint16_t* pKeyName,
    uint16_t* pSubkey,
    uint32_t cbSubkey,
    uint32_t* pcbSubkey);
C, "winspool.drv");
// $ffi->EnumPrinterKeyW(hPrinter, pKeyName, pSubkey, cbSubkey, pcbSubkey);
// hPrinter : PRINTER_HANDLE
// pKeyName : LPCWSTR
// pSubkey : LPWSTR optional, out
// cbSubkey : DWORD
// pcbSubkey : 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.UNICODE_OPTIONS);
    int EnumPrinterKeyW(
        PRINTER_HANDLE /* extends Structure (by value) */ hPrinter,   // PRINTER_HANDLE
        WString pKeyName,   // LPCWSTR
        char[] pSubkey,   // LPWSTR optional, out
        int cbSubkey,   // DWORD
        IntByReference pcbSubkey   // DWORD* out
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("winspool.drv")]
lib Libwinspool.drv
  fun EnumPrinterKeyW = EnumPrinterKeyW(
    hPrinter : PRINTER_HANDLE,   # PRINTER_HANDLE
    pKeyName : UInt16*,   # LPCWSTR
    pSubkey : UInt16*,   # LPWSTR optional, out
    cbSubkey : UInt32,   # DWORD
    pcbSubkey : 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 EnumPrinterKeyWNative = Uint32 Function(PRINTER_HANDLE, Pointer<Utf16>, Pointer<Utf16>, Uint32, Pointer<Uint32>);
typedef EnumPrinterKeyWDart = int Function(int, Pointer<Utf16>, Pointer<Utf16>, int, Pointer<Uint32>);
final EnumPrinterKeyW = DynamicLibrary.open('winspool.drv')
    .lookupFunction<EnumPrinterKeyWNative, EnumPrinterKeyWDart>('EnumPrinterKeyW');
// hPrinter : PRINTER_HANDLE -> PRINTER_HANDLE
// pKeyName : LPCWSTR -> Pointer<Utf16>
// pSubkey : LPWSTR optional, out -> Pointer<Utf16>
// cbSubkey : DWORD -> Uint32
// pcbSubkey : DWORD* out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function EnumPrinterKeyW(
  hPrinter: PRINTER_HANDLE;   // PRINTER_HANDLE
  pKeyName: PWideChar;   // LPCWSTR
  pSubkey: PWideChar;   // LPWSTR optional, out
  cbSubkey: DWORD;   // DWORD
  pcbSubkey: Pointer   // DWORD* out
): DWORD; stdcall;
  external 'winspool.drv' name 'EnumPrinterKeyW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let enumprinterkeyw =
  foreign "EnumPrinterKeyW"
    (PRINTER_HANDLE @-> (ptr uint16_t) @-> (ptr uint16_t) @-> uint32_t @-> (ptr uint32_t) @-> returning uint32_t)
(* hPrinter : PRINTER_HANDLE -> PRINTER_HANDLE *)
(* pKeyName : LPCWSTR -> (ptr uint16_t) *)
(* pSubkey : LPWSTR optional, out -> (ptr uint16_t) *)
(* cbSubkey : DWORD -> uint32_t *)
(* pcbSubkey : 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 ("EnumPrinterKeyW" enum-printer-key-w :convention :stdcall) :uint32
  (h-printer (:struct printer-handle))   ; PRINTER_HANDLE
  (p-key-name (:string :encoding :utf-16le))   ; LPCWSTR
  (p-subkey :pointer)   ; LPWSTR optional, out
  (cb-subkey :uint32)   ; DWORD
  (pcb-subkey :pointer))   ; DWORD* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $EnumPrinterKeyW = Win32::API::More->new('winspool.drv',
    'DWORD EnumPrinterKeyW(LPVOID hPrinter, LPCWSTR pKeyName, LPWSTR pSubkey, DWORD cbSubkey, LPVOID pcbSubkey)');
# my $ret = $EnumPrinterKeyW->Call($hPrinter, $pKeyName, $pSubkey, $cbSubkey, $pcbSubkey);
# hPrinter : PRINTER_HANDLE -> LPVOID
# pKeyName : LPCWSTR -> LPCWSTR
# pSubkey : LPWSTR optional, out -> LPWSTR
# cbSubkey : DWORD -> DWORD
# pcbSubkey : DWORD* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

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