EnumFormsW

関数

プリンターで利用可能な用紙フォームを列挙する。

DLLwinspool.drv文字セットUnicode (-W)呼出規約winapi

シグネチャ

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

BOOL EnumFormsW(
    PRINTER_HANDLE hPrinter,
    DWORD Level,
    BYTE* pForm,   // optional
    DWORD cbBuf,
    DWORD* pcbNeeded,
    DWORD* pcReturned
);

パラメーター

名前	型	方向	説明
hPrinter	PRINTER_HANDLE	in	フォームを列挙する対象プリンターのハンドル。
Level	DWORD	in	取得するFORM_INFO構造体のレベル。1または2を指定する。
pForm	BYTE*	outoptional	列挙結果を受け取るFORM_INFO_x配列用バッファへのポインタ。
cbBuf	DWORD	in	pFormバッファのサイズ(バイト単位)。
pcbNeeded	DWORD*	out	必要なバイト数を受け取る変数へのポインタ。
pcReturned	DWORD*	out	列挙されたフォーム数を受け取る変数へのポインタ。

戻り値の型: BOOL

各言語での呼び出し定義

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

BOOL EnumFormsW(
    PRINTER_HANDLE hPrinter,
    DWORD Level,
    BYTE* pForm,   // optional
    DWORD cbBuf,
    DWORD* pcbNeeded,
    DWORD* pcReturned
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("winspool.drv", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern bool EnumFormsW(
    PRINTER_HANDLE hPrinter,   // PRINTER_HANDLE
    uint Level,   // DWORD
    IntPtr pForm,   // 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 EnumFormsW(
    hPrinter As PRINTER_HANDLE,   ' PRINTER_HANDLE
    Level As UInteger,   ' DWORD
    pForm 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

' hPrinter : PRINTER_HANDLE
' Level : DWORD
' pForm : BYTE* optional, out
' cbBuf : DWORD
' pcbNeeded : DWORD* out
' pcReturned : DWORD* out
Declare PtrSafe Function EnumFormsW Lib "winspool.drv" ( _
    ByVal hPrinter As LongPtr, _
    ByVal Level As Long, _
    ByVal pForm 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

EnumFormsW = ctypes.windll.LoadLibrary("winspool.drv").EnumFormsW
EnumFormsW.restype = wintypes.BOOL
EnumFormsW.argtypes = [
    PRINTER_HANDLE,  # hPrinter : PRINTER_HANDLE
    wintypes.DWORD,  # Level : DWORD
    ctypes.POINTER(ctypes.c_ubyte),  # pForm : 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')
EnumFormsW = Fiddle::Function.new(
  lib['EnumFormsW'],
  [
    Fiddle::TYPE_VOIDP,  # hPrinter : PRINTER_HANDLE
    -Fiddle::TYPE_INT,  # Level : DWORD
    Fiddle::TYPE_VOIDP,  # pForm : 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 EnumFormsW(
        hPrinter: PRINTER_HANDLE,  // PRINTER_HANDLE
        Level: u32,  // DWORD
        pForm: *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 EnumFormsW(PRINTER_HANDLE hPrinter, uint Level, IntPtr pForm, uint cbBuf, out uint pcbNeeded, out uint pcReturned);
"@
$api = Add-Type -MemberDefinition $sig -Name 'winspool.drv_EnumFormsW' -Namespace Win32 -PassThru
# $api::EnumFormsW(hPrinter, Level, pForm, cbBuf, pcbNeeded, pcReturned)

#uselib "winspool.drv"
#func global EnumFormsW "EnumFormsW" wptr, wptr, wptr, wptr, wptr, wptr
; EnumFormsW hPrinter, Level, varptr(pForm), cbBuf, varptr(pcbNeeded), varptr(pcReturned)   ; 戻り値は stat
; hPrinter : PRINTER_HANDLE -> "wptr"
; Level : DWORD -> "wptr"
; pForm : BYTE* optional, out -> "wptr"
; cbBuf : DWORD -> "wptr"
; pcbNeeded : DWORD* out -> "wptr"
; pcReturned : DWORD* out -> "wptr"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "winspool.drv"
#cfunc global EnumFormsW "EnumFormsW" int, int, var, int, var, var
; res = EnumFormsW(hPrinter, Level, pForm, cbBuf, pcbNeeded, pcReturned)
; hPrinter : PRINTER_HANDLE -> "int"
; Level : DWORD -> "int"
; pForm : BYTE* optional, out -> "var"
; cbBuf : DWORD -> "int"
; pcbNeeded : DWORD* out -> "var"
; pcReturned : DWORD* out -> "var"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "winspool.drv"
#cfunc global EnumFormsW "EnumFormsW" int, int, sptr, int, sptr, sptr
; res = EnumFormsW(hPrinter, Level, varptr(pForm), cbBuf, varptr(pcbNeeded), varptr(pcReturned))
; hPrinter : PRINTER_HANDLE -> "int"
; Level : DWORD -> "int"
; pForm : BYTE* optional, out -> "sptr"
; cbBuf : DWORD -> "int"
; pcbNeeded : DWORD* out -> "sptr"
; pcReturned : DWORD* out -> "sptr"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。

出力引数:

; BOOL EnumFormsW(PRINTER_HANDLE hPrinter, DWORD Level, BYTE* pForm, DWORD cbBuf, DWORD* pcbNeeded, DWORD* pcReturned)
#uselib "winspool.drv"
#cfunc global EnumFormsW "EnumFormsW" int, int, var, int, var, var
; res = EnumFormsW(hPrinter, Level, pForm, cbBuf, pcbNeeded, pcReturned)
; hPrinter : PRINTER_HANDLE -> "int"
; Level : DWORD -> "int"
; pForm : BYTE* optional, out -> "var"
; cbBuf : DWORD -> "int"
; pcbNeeded : DWORD* out -> "var"
; pcReturned : DWORD* out -> "var"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; BOOL EnumFormsW(PRINTER_HANDLE hPrinter, DWORD Level, BYTE* pForm, DWORD cbBuf, DWORD* pcbNeeded, DWORD* pcReturned)
#uselib "winspool.drv"
#cfunc global EnumFormsW "EnumFormsW" int, int, intptr, int, intptr, intptr
; res = EnumFormsW(hPrinter, Level, varptr(pForm), cbBuf, varptr(pcbNeeded), varptr(pcReturned))
; hPrinter : PRINTER_HANDLE -> "int"
; Level : DWORD -> "int"
; pForm : BYTE* optional, out -> "intptr"
; cbBuf : DWORD -> "int"
; pcbNeeded : DWORD* out -> "intptr"
; pcReturned : DWORD* out -> "intptr"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。

import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	winspool_drv = windows.NewLazySystemDLL("winspool.drv")
	procEnumFormsW = winspool_drv.NewProc("EnumFormsW")
)

// hPrinter (PRINTER_HANDLE), Level (DWORD), pForm (BYTE* optional, out), cbBuf (DWORD), pcbNeeded (DWORD* out), pcReturned (DWORD* out)
r1, _, err := procEnumFormsW.Call(
	uintptr(hPrinter),
	uintptr(Level),
	uintptr(pForm),
	uintptr(cbBuf),
	uintptr(pcbNeeded),
	uintptr(pcReturned),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL

function EnumFormsW(
  hPrinter: PRINTER_HANDLE;   // PRINTER_HANDLE
  Level: DWORD;   // DWORD
  pForm: Pointer;   // BYTE* optional, out
  cbBuf: DWORD;   // DWORD
  pcbNeeded: Pointer;   // DWORD* out
  pcReturned: Pointer   // DWORD* out
): BOOL; stdcall;
  external 'winspool.drv' name 'EnumFormsW';

result := DllCall("winspool.drv\EnumFormsW"
    , "Ptr", hPrinter   ; PRINTER_HANDLE
    , "UInt", Level   ; DWORD
    , "Ptr", pForm   ; BYTE* optional, out
    , "UInt", cbBuf   ; DWORD
    , "Ptr", pcbNeeded   ; DWORD* out
    , "Ptr", pcReturned   ; DWORD* out
    , "Int")   ; return: BOOL

●EnumFormsW(hPrinter, Level, pForm, cbBuf, pcbNeeded, pcReturned) = DLL("winspool.drv", "bool EnumFormsW(void*, dword, void*, dword, void*, void*)")
# 呼び出し: EnumFormsW(hPrinter, Level, pForm, cbBuf, pcbNeeded, pcReturned)
# hPrinter : PRINTER_HANDLE -> "void*"
# Level : DWORD -> "dword"
# pForm : 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 版の利用を推奨。

const std = @import("std");

extern "winspool.drv" fn EnumFormsW(
    hPrinter: PRINTER_HANDLE, // PRINTER_HANDLE
    Level: u32, // DWORD
    pForm: [*c]u8, // BYTE* optional, out
    cbBuf: u32, // DWORD
    pcbNeeded: [*c]u32, // DWORD* out
    pcReturned: [*c]u32 // DWORD* out
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。

proc EnumFormsW(
    hPrinter: PRINTER_HANDLE,  # PRINTER_HANDLE
    Level: uint32,  # DWORD
    pForm: ptr uint8,  # BYTE* optional, out
    cbBuf: uint32,  # DWORD
    pcbNeeded: ptr uint32,  # DWORD* out
    pcReturned: ptr uint32  # DWORD* out
): int32 {.importc: "EnumFormsW", stdcall, dynlib: "winspool.drv".}
# Unicode(-W): WideCString は newWideCString("...") で生成。

pragma(lib, "winspool.drv");
extern(Windows)
int EnumFormsW(
    PRINTER_HANDLE hPrinter,   // PRINTER_HANDLE
    uint Level,   // DWORD
    ubyte* pForm,   // BYTE* optional, out
    uint cbBuf,   // DWORD
    uint* pcbNeeded,   // DWORD* out
    uint* pcReturned   // DWORD* out
);

ccall((:EnumFormsW, "winspool.drv"), stdcall, Int32,
      (PRINTER_HANDLE, UInt32, Ptr{UInt8}, UInt32, Ptr{UInt32}, Ptr{UInt32}),
      hPrinter, Level, pForm, cbBuf, pcbNeeded, pcReturned)
# hPrinter : PRINTER_HANDLE -> PRINTER_HANDLE
# Level : DWORD -> UInt32
# pForm : BYTE* optional, out -> Ptr{UInt8}
# cbBuf : DWORD -> UInt32
# pcbNeeded : DWORD* out -> Ptr{UInt32}
# pcReturned : DWORD* out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。

local ffi = require("ffi")
ffi.cdef[[
int32_t EnumFormsW(
    PRINTER_HANDLE hPrinter,
    uint32_t Level,
    uint8_t* pForm,
    uint32_t cbBuf,
    uint32_t* pcbNeeded,
    uint32_t* pcReturned);
]]
local winspool.drv = ffi.load("winspool.drv")
-- winspool.drv.EnumFormsW(hPrinter, Level, pForm, cbBuf, pcbNeeded, pcReturned)
-- hPrinter : PRINTER_HANDLE
-- Level : DWORD
-- pForm : BYTE* optional, out
-- cbBuf : DWORD
-- pcbNeeded : DWORD* out
-- pcReturned : 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 EnumFormsW = lib.func('__stdcall', 'EnumFormsW', 'int32_t', ['PRINTER_HANDLE', 'uint32_t', 'uint8_t *', 'uint32_t', 'uint32_t *', 'uint32_t *']);
// EnumFormsW(hPrinter, Level, pForm, cbBuf, pcbNeeded, pcReturned)
// hPrinter : PRINTER_HANDLE -> 'PRINTER_HANDLE'
// Level : DWORD -> 'uint32_t'
// pForm : 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", {
  EnumFormsW: { parameters: ["buffer", "u32", "pointer", "u32", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.EnumFormsW(hPrinter, Level, pForm, cbBuf, pcbNeeded, pcReturned)
// hPrinter : PRINTER_HANDLE -> "buffer"
// Level : DWORD -> "u32"
// pForm : BYTE* optional, out -> "pointer"
// cbBuf : DWORD -> "u32"
// pcbNeeded : DWORD* out -> "pointer"
// pcReturned : DWORD* out -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。

<?php
$ffi = FFI::cdef(<<<C
int32_t EnumFormsW(
    PRINTER_HANDLE hPrinter,
    uint32_t Level,
    uint8_t* pForm,
    uint32_t cbBuf,
    uint32_t* pcbNeeded,
    uint32_t* pcReturned);
C, "winspool.drv");
// $ffi->EnumFormsW(hPrinter, Level, pForm, cbBuf, pcbNeeded, pcReturned);
// hPrinter : PRINTER_HANDLE
// Level : DWORD
// pForm : 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.UNICODE_OPTIONS);
    boolean EnumFormsW(
        PRINTER_HANDLE /* extends Structure (by value) */ hPrinter,   // PRINTER_HANDLE
        int Level,   // DWORD
        byte[] pForm,   // BYTE* optional, out
        int cbBuf,   // DWORD
        IntByReference pcbNeeded,   // DWORD* out
        IntByReference pcReturned   // DWORD* out
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。

@[Link("winspool.drv")]
lib Libwinspool.drv
  fun EnumFormsW = EnumFormsW(
    hPrinter : PRINTER_HANDLE,   # PRINTER_HANDLE
    Level : UInt32,   # DWORD
    pForm : 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 EnumFormsWNative = Int32 Function(PRINTER_HANDLE, Uint32, Pointer<Uint8>, Uint32, Pointer<Uint32>, Pointer<Uint32>);
typedef EnumFormsWDart = int Function(int, int, Pointer<Uint8>, int, Pointer<Uint32>, Pointer<Uint32>);
final EnumFormsW = DynamicLibrary.open('winspool.drv')
    .lookupFunction<EnumFormsWNative, EnumFormsWDart>('EnumFormsW');
// hPrinter : PRINTER_HANDLE -> PRINTER_HANDLE
// Level : DWORD -> Uint32
// pForm : 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 EnumFormsW(
  hPrinter: PRINTER_HANDLE;   // PRINTER_HANDLE
  Level: DWORD;   // DWORD
  pForm: Pointer;   // BYTE* optional, out
  cbBuf: DWORD;   // DWORD
  pcbNeeded: Pointer;   // DWORD* out
  pcReturned: Pointer   // DWORD* out
): BOOL; stdcall;
  external 'winspool.drv' name 'EnumFormsW';

import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "EnumFormsW"
  c_EnumFormsW :: PRINTER_HANDLE -> Word32 -> Ptr Word8 -> Word32 -> Ptr Word32 -> Ptr Word32 -> IO CInt
-- hPrinter : PRINTER_HANDLE -> PRINTER_HANDLE
-- Level : DWORD -> Word32
-- pForm : 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 呼び出し推奨。
-- ※値渡し構造体は GHC FFI で直接渡せません。Ptr で渡すラッパ(C側)経由にしてください。

open Ctypes
open Foreign

let enumformsw =
  foreign "EnumFormsW"
    (PRINTER_HANDLE @-> uint32_t @-> (ptr uint8_t) @-> uint32_t @-> (ptr uint32_t) @-> (ptr uint32_t) @-> returning int32_t)
(* hPrinter : PRINTER_HANDLE -> PRINTER_HANDLE *)
(* Level : DWORD -> uint32_t *)
(* pForm : 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 ("EnumFormsW" enum-forms-w :convention :stdcall) :int32
  (h-printer (:struct printer-handle))   ; PRINTER_HANDLE
  (level :uint32)   ; DWORD
  (p-form :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 $EnumFormsW = Win32::API::More->new('winspool.drv',
    'BOOL EnumFormsW(LPVOID hPrinter, DWORD Level, LPVOID pForm, DWORD cbBuf, LPVOID pcbNeeded, LPVOID pcReturned)');
# my $ret = $EnumFormsW->Call($hPrinter, $Level, $pForm, $cbBuf, $pcbNeeded, $pcReturned);
# hPrinter : PRINTER_HANDLE -> LPVOID
# Level : DWORD -> DWORD
# pForm : BYTE* optional, out -> LPVOID
# cbBuf : DWORD -> DWORD
# pcbNeeded : DWORD* out -> LPVOID
# pcReturned : DWORD* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

EnumFormsW

シグネチャ

パラメーター

各言語での呼び出し定義

関連項目