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

SetPrinterW

関数
プリンタの構成情報や状態を設定する(Unicode版)。
DLLwinspool.drv文字セットUnicode (-W)呼出規約winapiSetLastErrorあり
📘 Microsoft Learn (日本語) · English

シグネチャ

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

BOOL SetPrinterW(
    PRINTER_HANDLE hPrinter,
    DWORD Level,
    BYTE* pPrinter,   // optional
    DWORD Command
);

パラメーター

名前型方向説明
hPrinterPRINTER_HANDLEin設定変更対象プリンターのハンドル。OpenPrinterで取得する。
LevelDWORDinpPrinterが指す構造体のレベル番号。0や1〜9を指定する。
pPrinterBYTE*inoptional設定内容を格納したPRINTER_INFO_x構造体へのポインタ。状態変更のみならNULL可。
CommandDWORDin実行するアクション。PRINTER_CONTROL_PAUSE等の制御コマンドを指定する。

戻り値の型: BOOL

各言語での呼び出し定義

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

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

SetPrinterW = ctypes.windll.LoadLibrary("winspool.drv").SetPrinterW
SetPrinterW.restype = wintypes.BOOL
SetPrinterW.argtypes = [
    PRINTER_HANDLE,  # hPrinter : PRINTER_HANDLE
    wintypes.DWORD,  # Level : DWORD
    ctypes.POINTER(ctypes.c_ubyte),  # pPrinter : BYTE* optional
    wintypes.DWORD,  # Command : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

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

var (
	winspool_drv = windows.NewLazySystemDLL("winspool.drv")
	procSetPrinterW = winspool_drv.NewProc("SetPrinterW")
)

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

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

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

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

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

関連項目

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