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

PrinterMessageBoxW

関数
プリンター関連のメッセージボックスを表示する。
DLLwinspool.drv文字セットUnicode (-W)呼出規約winapi

シグネチャ

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

DWORD PrinterMessageBoxW(
    PRINTER_HANDLE hPrinter,
    DWORD Error,
    HWND hWnd,
    LPWSTR pText,
    LPWSTR pCaption,
    DWORD dwType
);

パラメーター

名前方向説明
hPrinterPRINTER_HANDLEinメッセージ対象の印刷ジョブを持つプリンターのハンドル。
ErrorDWORDin表示するエラーコード。システムエラー値を指定する。
hWndHWNDinメッセージボックスの親ウィンドウのハンドル。
pTextLPWSTRin表示する本文テキストを指すポインタ。
pCaptionLPWSTRinメッセージボックスのタイトル文字列を指すポインタ。
dwTypeDWORDinボタンやアイコンを指定するメッセージボックススタイルフラグ。

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD PrinterMessageBoxW(
    PRINTER_HANDLE hPrinter,
    DWORD Error,
    HWND hWnd,
    LPWSTR pText,
    LPWSTR pCaption,
    DWORD dwType
);
[DllImport("winspool.drv", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint PrinterMessageBoxW(
    PRINTER_HANDLE hPrinter,   // PRINTER_HANDLE
    uint Error,   // DWORD
    IntPtr hWnd,   // HWND
    [MarshalAs(UnmanagedType.LPWStr)] string pText,   // LPWSTR
    [MarshalAs(UnmanagedType.LPWStr)] string pCaption,   // LPWSTR
    uint dwType   // DWORD
);
<DllImport("winspool.drv", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function PrinterMessageBoxW(
    hPrinter As PRINTER_HANDLE,   ' PRINTER_HANDLE
    [Error] As UInteger,   ' DWORD
    hWnd As IntPtr,   ' HWND
    <MarshalAs(UnmanagedType.LPWStr)> pText As String,   ' LPWSTR
    <MarshalAs(UnmanagedType.LPWStr)> pCaption As String,   ' LPWSTR
    dwType As UInteger   ' DWORD
) As UInteger
End Function
' hPrinter : PRINTER_HANDLE
' Error : DWORD
' hWnd : HWND
' pText : LPWSTR
' pCaption : LPWSTR
' dwType : DWORD
Declare PtrSafe Function PrinterMessageBoxW Lib "winspool.drv" ( _
    ByVal hPrinter As LongPtr, _
    ByVal Error As Long, _
    ByVal hWnd As LongPtr, _
    ByVal pText As LongPtr, _
    ByVal pCaption As LongPtr, _
    ByVal dwType 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

PrinterMessageBoxW = ctypes.windll.LoadLibrary("winspool.drv").PrinterMessageBoxW
PrinterMessageBoxW.restype = wintypes.DWORD
PrinterMessageBoxW.argtypes = [
    PRINTER_HANDLE,  # hPrinter : PRINTER_HANDLE
    wintypes.DWORD,  # Error : DWORD
    wintypes.HANDLE,  # hWnd : HWND
    wintypes.LPCWSTR,  # pText : LPWSTR
    wintypes.LPCWSTR,  # pCaption : LPWSTR
    wintypes.DWORD,  # dwType : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('winspool.drv')
PrinterMessageBoxW = Fiddle::Function.new(
  lib['PrinterMessageBoxW'],
  [
    Fiddle::TYPE_VOIDP,  # hPrinter : PRINTER_HANDLE
    -Fiddle::TYPE_INT,  # Error : DWORD
    Fiddle::TYPE_VOIDP,  # hWnd : HWND
    Fiddle::TYPE_VOIDP,  # pText : LPWSTR
    Fiddle::TYPE_VOIDP,  # pCaption : LPWSTR
    -Fiddle::TYPE_INT,  # dwType : DWORD
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "winspool.drv")]
extern "system" {
    fn PrinterMessageBoxW(
        hPrinter: PRINTER_HANDLE,  // PRINTER_HANDLE
        Error: u32,  // DWORD
        hWnd: *mut core::ffi::c_void,  // HWND
        pText: *mut u16,  // LPWSTR
        pCaption: *mut u16,  // LPWSTR
        dwType: u32  // DWORD
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("winspool.drv", CharSet = CharSet.Unicode)]
public static extern uint PrinterMessageBoxW(PRINTER_HANDLE hPrinter, uint Error, IntPtr hWnd, [MarshalAs(UnmanagedType.LPWStr)] string pText, [MarshalAs(UnmanagedType.LPWStr)] string pCaption, uint dwType);
"@
$api = Add-Type -MemberDefinition $sig -Name 'winspool.drv_PrinterMessageBoxW' -Namespace Win32 -PassThru
# $api::PrinterMessageBoxW(hPrinter, Error, hWnd, pText, pCaption, dwType)
#uselib "winspool.drv"
#func global PrinterMessageBoxW "PrinterMessageBoxW" wptr, wptr, wptr, wptr, wptr, wptr
; PrinterMessageBoxW hPrinter, Error, hWnd, pText, pCaption, dwType   ; 戻り値は stat
; hPrinter : PRINTER_HANDLE -> "wptr"
; Error : DWORD -> "wptr"
; hWnd : HWND -> "wptr"
; pText : LPWSTR -> "wptr"
; pCaption : LPWSTR -> "wptr"
; dwType : DWORD -> "wptr"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "winspool.drv"
#cfunc global PrinterMessageBoxW "PrinterMessageBoxW" int, int, sptr, wstr, wstr, int
; res = PrinterMessageBoxW(hPrinter, Error, hWnd, pText, pCaption, dwType)
; hPrinter : PRINTER_HANDLE -> "int"
; Error : DWORD -> "int"
; hWnd : HWND -> "sptr"
; pText : LPWSTR -> "wstr"
; pCaption : LPWSTR -> "wstr"
; dwType : DWORD -> "int"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; DWORD PrinterMessageBoxW(PRINTER_HANDLE hPrinter, DWORD Error, HWND hWnd, LPWSTR pText, LPWSTR pCaption, DWORD dwType)
#uselib "winspool.drv"
#cfunc global PrinterMessageBoxW "PrinterMessageBoxW" int, int, intptr, wstr, wstr, int
; res = PrinterMessageBoxW(hPrinter, Error, hWnd, pText, pCaption, dwType)
; hPrinter : PRINTER_HANDLE -> "int"
; Error : DWORD -> "int"
; hWnd : HWND -> "intptr"
; pText : LPWSTR -> "wstr"
; pCaption : LPWSTR -> "wstr"
; dwType : DWORD -> "int"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	winspool_drv = windows.NewLazySystemDLL("winspool.drv")
	procPrinterMessageBoxW = winspool_drv.NewProc("PrinterMessageBoxW")
)

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

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

typedef PrinterMessageBoxWNative = Uint32 Function(PRINTER_HANDLE, Uint32, Pointer<Void>, Pointer<Utf16>, Pointer<Utf16>, Uint32);
typedef PrinterMessageBoxWDart = int Function(int, int, Pointer<Void>, Pointer<Utf16>, Pointer<Utf16>, int);
final PrinterMessageBoxW = DynamicLibrary.open('winspool.drv')
    .lookupFunction<PrinterMessageBoxWNative, PrinterMessageBoxWDart>('PrinterMessageBoxW');
// hPrinter : PRINTER_HANDLE -> PRINTER_HANDLE
// Error : DWORD -> Uint32
// hWnd : HWND -> Pointer<Void>
// pText : LPWSTR -> Pointer<Utf16>
// pCaption : LPWSTR -> Pointer<Utf16>
// dwType : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function PrinterMessageBoxW(
  hPrinter: PRINTER_HANDLE;   // PRINTER_HANDLE
  Error: DWORD;   // DWORD
  hWnd: THandle;   // HWND
  pText: PWideChar;   // LPWSTR
  pCaption: PWideChar;   // LPWSTR
  dwType: DWORD   // DWORD
): DWORD; stdcall;
  external 'winspool.drv' name 'PrinterMessageBoxW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "PrinterMessageBoxW"
  c_PrinterMessageBoxW :: PRINTER_HANDLE -> Word32 -> Ptr () -> CWString -> CWString -> Word32 -> IO Word32
-- hPrinter : PRINTER_HANDLE -> PRINTER_HANDLE
-- Error : DWORD -> Word32
-- hWnd : HWND -> Ptr ()
-- pText : LPWSTR -> CWString
-- pCaption : LPWSTR -> CWString
-- dwType : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
-- ※値渡し構造体は GHC FFI で直接渡せません。Ptr で渡すラッパ(C側)経由にしてください。
open Ctypes
open Foreign

let printermessageboxw =
  foreign "PrinterMessageBoxW"
    (PRINTER_HANDLE @-> uint32_t @-> (ptr void) @-> (ptr uint16_t) @-> (ptr uint16_t) @-> uint32_t @-> returning uint32_t)
(* hPrinter : PRINTER_HANDLE -> PRINTER_HANDLE *)
(* Error : DWORD -> uint32_t *)
(* hWnd : HWND -> (ptr void) *)
(* pText : LPWSTR -> (ptr uint16_t) *)
(* pCaption : LPWSTR -> (ptr uint16_t) *)
(* dwType : 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 ("PrinterMessageBoxW" printer-message-box-w :convention :stdcall) :uint32
  (h-printer (:struct printer-handle))   ; PRINTER_HANDLE
  (error :uint32)   ; DWORD
  (h-wnd :pointer)   ; HWND
  (p-text (:string :encoding :utf-16le))   ; LPWSTR
  (p-caption (:string :encoding :utf-16le))   ; LPWSTR
  (dw-type :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $PrinterMessageBoxW = Win32::API::More->new('winspool.drv',
    'DWORD PrinterMessageBoxW(LPVOID hPrinter, DWORD Error, HANDLE hWnd, LPCWSTR pText, LPCWSTR pCaption, DWORD dwType)');
# my $ret = $PrinterMessageBoxW->Call($hPrinter, $Error, $hWnd, $pText, $pCaption, $dwType);
# hPrinter : PRINTER_HANDLE -> LPVOID
# Error : DWORD -> DWORD
# hWnd : HWND -> HANDLE
# pText : LPWSTR -> LPCWSTR
# pCaption : LPWSTR -> LPCWSTR
# dwType : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

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