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

SetFormW

関数
指定した用紙フォームの情報を設定する。
DLLwinspool.drv文字セットUnicode (-W)呼出規約winapi

シグネチャ

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

BOOL SetFormW(
    PRINTER_HANDLE hPrinter,
    LPCWSTR pFormName,
    DWORD Level,
    BYTE* pForm
);

パラメーター

名前方向説明
hPrinterPRINTER_HANDLEinフォームを変更する対象プリンターのハンドル。
pFormNameLPCWSTRin変更するフォームの名前を指すポインタ。
LevelDWORDinpFormが指す構造体のレベル。1または2を指定する。
pFormBYTE*in変更後のフォーム情報を格納したFORM_INFO_x構造体へのポインタ。

戻り値の型: BOOL

各言語での呼び出し定義

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

BOOL SetFormW(
    PRINTER_HANDLE hPrinter,
    LPCWSTR pFormName,
    DWORD Level,
    BYTE* pForm
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("winspool.drv", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern bool SetFormW(
    PRINTER_HANDLE hPrinter,   // PRINTER_HANDLE
    [MarshalAs(UnmanagedType.LPWStr)] string pFormName,   // LPCWSTR
    uint Level,   // DWORD
    IntPtr pForm   // BYTE*
);
<DllImport("winspool.drv", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function SetFormW(
    hPrinter As PRINTER_HANDLE,   ' PRINTER_HANDLE
    <MarshalAs(UnmanagedType.LPWStr)> pFormName As String,   ' LPCWSTR
    Level As UInteger,   ' DWORD
    pForm As IntPtr   ' BYTE*
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' hPrinter : PRINTER_HANDLE
' pFormName : LPCWSTR
' Level : DWORD
' pForm : BYTE*
Declare PtrSafe Function SetFormW Lib "winspool.drv" ( _
    ByVal hPrinter As LongPtr, _
    ByVal pFormName As LongPtr, _
    ByVal Level As Long, _
    ByVal pForm As LongPtr) 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

SetFormW = ctypes.windll.LoadLibrary("winspool.drv").SetFormW
SetFormW.restype = wintypes.BOOL
SetFormW.argtypes = [
    PRINTER_HANDLE,  # hPrinter : PRINTER_HANDLE
    wintypes.LPCWSTR,  # pFormName : LPCWSTR
    wintypes.DWORD,  # Level : DWORD
    ctypes.POINTER(ctypes.c_ubyte),  # pForm : BYTE*
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('winspool.drv')
SetFormW = Fiddle::Function.new(
  lib['SetFormW'],
  [
    Fiddle::TYPE_VOIDP,  # hPrinter : PRINTER_HANDLE
    Fiddle::TYPE_VOIDP,  # pFormName : LPCWSTR
    -Fiddle::TYPE_INT,  # Level : DWORD
    Fiddle::TYPE_VOIDP,  # pForm : BYTE*
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "winspool.drv")]
extern "system" {
    fn SetFormW(
        hPrinter: PRINTER_HANDLE,  // PRINTER_HANDLE
        pFormName: *const u16,  // LPCWSTR
        Level: u32,  // DWORD
        pForm: *mut u8  // BYTE*
    ) -> 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 SetFormW(PRINTER_HANDLE hPrinter, [MarshalAs(UnmanagedType.LPWStr)] string pFormName, uint Level, IntPtr pForm);
"@
$api = Add-Type -MemberDefinition $sig -Name 'winspool.drv_SetFormW' -Namespace Win32 -PassThru
# $api::SetFormW(hPrinter, pFormName, Level, pForm)
#uselib "winspool.drv"
#func global SetFormW "SetFormW" wptr, wptr, wptr, wptr
; SetFormW hPrinter, pFormName, Level, varptr(pForm)   ; 戻り値は stat
; hPrinter : PRINTER_HANDLE -> "wptr"
; pFormName : LPCWSTR -> "wptr"
; Level : DWORD -> "wptr"
; pForm : BYTE* -> "wptr"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "winspool.drv"
#cfunc global SetFormW "SetFormW" int, wstr, int, var
; res = SetFormW(hPrinter, pFormName, Level, pForm)
; hPrinter : PRINTER_HANDLE -> "int"
; pFormName : LPCWSTR -> "wstr"
; Level : DWORD -> "int"
; pForm : BYTE* -> "var"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL SetFormW(PRINTER_HANDLE hPrinter, LPCWSTR pFormName, DWORD Level, BYTE* pForm)
#uselib "winspool.drv"
#cfunc global SetFormW "SetFormW" int, wstr, int, var
; res = SetFormW(hPrinter, pFormName, Level, pForm)
; hPrinter : PRINTER_HANDLE -> "int"
; pFormName : LPCWSTR -> "wstr"
; Level : DWORD -> "int"
; pForm : BYTE* -> "var"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	winspool_drv = windows.NewLazySystemDLL("winspool.drv")
	procSetFormW = winspool_drv.NewProc("SetFormW")
)

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

extern "winspool.drv" fn SetFormW(
    hPrinter: PRINTER_HANDLE, // PRINTER_HANDLE
    pFormName: [*c]const u16, // LPCWSTR
    Level: u32, // DWORD
    pForm: [*c]u8 // BYTE*
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc SetFormW(
    hPrinter: PRINTER_HANDLE,  # PRINTER_HANDLE
    pFormName: WideCString,  # LPCWSTR
    Level: uint32,  # DWORD
    pForm: ptr uint8  # BYTE*
): int32 {.importc: "SetFormW", stdcall, dynlib: "winspool.drv".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "winspool.drv");
extern(Windows)
int SetFormW(
    PRINTER_HANDLE hPrinter,   // PRINTER_HANDLE
    const(wchar)* pFormName,   // LPCWSTR
    uint Level,   // DWORD
    ubyte* pForm   // BYTE*
);
ccall((:SetFormW, "winspool.drv"), stdcall, Int32,
      (PRINTER_HANDLE, Cwstring, UInt32, Ptr{UInt8}),
      hPrinter, pFormName, Level, pForm)
# hPrinter : PRINTER_HANDLE -> PRINTER_HANDLE
# pFormName : LPCWSTR -> Cwstring
# Level : DWORD -> UInt32
# pForm : BYTE* -> Ptr{UInt8}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t SetFormW(
    PRINTER_HANDLE hPrinter,
    const uint16_t* pFormName,
    uint32_t Level,
    uint8_t* pForm);
]]
local winspool.drv = ffi.load("winspool.drv")
-- winspool.drv.SetFormW(hPrinter, pFormName, Level, pForm)
-- hPrinter : PRINTER_HANDLE
-- pFormName : LPCWSTR
-- Level : DWORD
-- pForm : BYTE*
-- 構造体/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 SetFormW = lib.func('__stdcall', 'SetFormW', 'int32_t', ['PRINTER_HANDLE', 'str16', 'uint32_t', 'uint8_t *']);
// SetFormW(hPrinter, pFormName, Level, pForm)
// hPrinter : PRINTER_HANDLE -> 'PRINTER_HANDLE'
// pFormName : LPCWSTR -> 'str16'
// Level : DWORD -> 'uint32_t'
// pForm : BYTE* -> 'uint8_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("winspool.drv", {
  SetFormW: { parameters: ["buffer", "buffer", "u32", "pointer"], result: "i32" },
});
// lib.symbols.SetFormW(hPrinter, pFormName, Level, pForm)
// hPrinter : PRINTER_HANDLE -> "buffer"
// pFormName : LPCWSTR -> "buffer"
// Level : DWORD -> "u32"
// pForm : BYTE* -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SetFormW(
    PRINTER_HANDLE hPrinter,
    const uint16_t* pFormName,
    uint32_t Level,
    uint8_t* pForm);
C, "winspool.drv");
// $ffi->SetFormW(hPrinter, pFormName, Level, pForm);
// hPrinter : PRINTER_HANDLE
// pFormName : LPCWSTR
// Level : DWORD
// pForm : BYTE*
// 構造体/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 SetFormW(
        PRINTER_HANDLE /* extends Structure (by value) */ hPrinter,   // PRINTER_HANDLE
        WString pFormName,   // LPCWSTR
        int Level,   // DWORD
        byte[] pForm   // BYTE*
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("winspool.drv")]
lib Libwinspool.drv
  fun SetFormW = SetFormW(
    hPrinter : PRINTER_HANDLE,   # PRINTER_HANDLE
    pFormName : UInt16*,   # LPCWSTR
    Level : UInt32,   # DWORD
    pForm : UInt8*   # BYTE*
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef SetFormWNative = Int32 Function(PRINTER_HANDLE, Pointer<Utf16>, Uint32, Pointer<Uint8>);
typedef SetFormWDart = int Function(int, Pointer<Utf16>, int, Pointer<Uint8>);
final SetFormW = DynamicLibrary.open('winspool.drv')
    .lookupFunction<SetFormWNative, SetFormWDart>('SetFormW');
// hPrinter : PRINTER_HANDLE -> PRINTER_HANDLE
// pFormName : LPCWSTR -> Pointer<Utf16>
// Level : DWORD -> Uint32
// pForm : BYTE* -> Pointer<Uint8>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SetFormW(
  hPrinter: PRINTER_HANDLE;   // PRINTER_HANDLE
  pFormName: PWideChar;   // LPCWSTR
  Level: DWORD;   // DWORD
  pForm: Pointer   // BYTE*
): BOOL; stdcall;
  external 'winspool.drv' name 'SetFormW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SetFormW"
  c_SetFormW :: PRINTER_HANDLE -> CWString -> Word32 -> Ptr Word8 -> IO CInt
-- hPrinter : PRINTER_HANDLE -> PRINTER_HANDLE
-- pFormName : LPCWSTR -> CWString
-- Level : DWORD -> Word32
-- pForm : BYTE* -> Ptr Word8
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
-- ※値渡し構造体は GHC FFI で直接渡せません。Ptr で渡すラッパ(C側)経由にしてください。
open Ctypes
open Foreign

let setformw =
  foreign "SetFormW"
    (PRINTER_HANDLE @-> (ptr uint16_t) @-> uint32_t @-> (ptr uint8_t) @-> returning int32_t)
(* hPrinter : PRINTER_HANDLE -> PRINTER_HANDLE *)
(* pFormName : LPCWSTR -> (ptr uint16_t) *)
(* Level : DWORD -> uint32_t *)
(* pForm : BYTE* -> (ptr uint8_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 ("SetFormW" set-form-w :convention :stdcall) :int32
  (h-printer (:struct printer-handle))   ; PRINTER_HANDLE
  (p-form-name (:string :encoding :utf-16le))   ; LPCWSTR
  (level :uint32)   ; DWORD
  (p-form :pointer))   ; BYTE*
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SetFormW = Win32::API::More->new('winspool.drv',
    'BOOL SetFormW(LPVOID hPrinter, LPCWSTR pFormName, DWORD Level, LPVOID pForm)');
# my $ret = $SetFormW->Call($hPrinter, $pFormName, $Level, $pForm);
# hPrinter : PRINTER_HANDLE -> LPVOID
# pFormName : LPCWSTR -> LPCWSTR
# Level : DWORD -> DWORD
# pForm : BYTE* -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

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