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

OpenPrinter2W

関数
オプション指定付きでプリンターを開きハンドルを取得する。
DLLwinspool.drv文字セットUnicode (-W)呼出規約winapiSetLastErrorあり

シグネチャ

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

BOOL OpenPrinter2W(
    LPCWSTR pPrinterName,   // optional
    PRINTER_HANDLE* phPrinter,
    PRINTER_DEFAULTSW* pDefault,   // optional
    PRINTER_OPTIONSW* pOptions   // optional
);

パラメーター

名前方向説明
pPrinterNameLPCWSTRinoptional開くプリンター名やサーバー名、ポート名を指すポインタ。
phPrinterPRINTER_HANDLE*out取得したプリンターハンドルを受け取る変数へのポインタ。
pDefaultPRINTER_DEFAULTSW*inoptionalアクセス権やデフォルトのデータ型を指定するPRINTER_DEFAULTS構造体へのポインタ。NULL可。
pOptionsPRINTER_OPTIONSW*inoptional開く際の追加オプションを指定するPRINTER_OPTIONS構造体へのポインタ。NULL可。

戻り値の型: BOOL

各言語での呼び出し定義

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

BOOL OpenPrinter2W(
    LPCWSTR pPrinterName,   // optional
    PRINTER_HANDLE* phPrinter,
    PRINTER_DEFAULTSW* pDefault,   // optional
    PRINTER_OPTIONSW* pOptions   // optional
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("winspool.drv", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool OpenPrinter2W(
    [MarshalAs(UnmanagedType.LPWStr)] string pPrinterName,   // LPCWSTR optional
    IntPtr phPrinter,   // PRINTER_HANDLE* out
    IntPtr pDefault,   // PRINTER_DEFAULTSW* optional
    IntPtr pOptions   // PRINTER_OPTIONSW* optional
);
<DllImport("winspool.drv", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function OpenPrinter2W(
    <MarshalAs(UnmanagedType.LPWStr)> pPrinterName As String,   ' LPCWSTR optional
    phPrinter As IntPtr,   ' PRINTER_HANDLE* out
    pDefault As IntPtr,   ' PRINTER_DEFAULTSW* optional
    pOptions As IntPtr   ' PRINTER_OPTIONSW* optional
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' pPrinterName : LPCWSTR optional
' phPrinter : PRINTER_HANDLE* out
' pDefault : PRINTER_DEFAULTSW* optional
' pOptions : PRINTER_OPTIONSW* optional
Declare PtrSafe Function OpenPrinter2W Lib "winspool.drv" ( _
    ByVal pPrinterName As LongPtr, _
    ByVal phPrinter As LongPtr, _
    ByVal pDefault As LongPtr, _
    ByVal pOptions 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

OpenPrinter2W = ctypes.windll.LoadLibrary("winspool.drv").OpenPrinter2W
OpenPrinter2W.restype = wintypes.BOOL
OpenPrinter2W.argtypes = [
    wintypes.LPCWSTR,  # pPrinterName : LPCWSTR optional
    ctypes.c_void_p,  # phPrinter : PRINTER_HANDLE* out
    ctypes.c_void_p,  # pDefault : PRINTER_DEFAULTSW* optional
    ctypes.c_void_p,  # pOptions : PRINTER_OPTIONSW* optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('winspool.drv')
OpenPrinter2W = Fiddle::Function.new(
  lib['OpenPrinter2W'],
  [
    Fiddle::TYPE_VOIDP,  # pPrinterName : LPCWSTR optional
    Fiddle::TYPE_VOIDP,  # phPrinter : PRINTER_HANDLE* out
    Fiddle::TYPE_VOIDP,  # pDefault : PRINTER_DEFAULTSW* optional
    Fiddle::TYPE_VOIDP,  # pOptions : PRINTER_OPTIONSW* optional
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "winspool.drv")]
extern "system" {
    fn OpenPrinter2W(
        pPrinterName: *const u16,  // LPCWSTR optional
        phPrinter: *mut PRINTER_HANDLE,  // PRINTER_HANDLE* out
        pDefault: *mut PRINTER_DEFAULTSW,  // PRINTER_DEFAULTSW* optional
        pOptions: *mut PRINTER_OPTIONSW  // PRINTER_OPTIONSW* optional
    ) -> 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 OpenPrinter2W([MarshalAs(UnmanagedType.LPWStr)] string pPrinterName, IntPtr phPrinter, IntPtr pDefault, IntPtr pOptions);
"@
$api = Add-Type -MemberDefinition $sig -Name 'winspool.drv_OpenPrinter2W' -Namespace Win32 -PassThru
# $api::OpenPrinter2W(pPrinterName, phPrinter, pDefault, pOptions)
#uselib "winspool.drv"
#func global OpenPrinter2W "OpenPrinter2W" wptr, wptr, wptr, wptr
; OpenPrinter2W pPrinterName, varptr(phPrinter), varptr(pDefault), varptr(pOptions)   ; 戻り値は stat
; pPrinterName : LPCWSTR optional -> "wptr"
; phPrinter : PRINTER_HANDLE* out -> "wptr"
; pDefault : PRINTER_DEFAULTSW* optional -> "wptr"
; pOptions : PRINTER_OPTIONSW* optional -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "winspool.drv"
#cfunc global OpenPrinter2W "OpenPrinter2W" wstr, var, var, var
; res = OpenPrinter2W(pPrinterName, phPrinter, pDefault, pOptions)
; pPrinterName : LPCWSTR optional -> "wstr"
; phPrinter : PRINTER_HANDLE* out -> "var"
; pDefault : PRINTER_DEFAULTSW* optional -> "var"
; pOptions : PRINTER_OPTIONSW* optional -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL OpenPrinter2W(LPCWSTR pPrinterName, PRINTER_HANDLE* phPrinter, PRINTER_DEFAULTSW* pDefault, PRINTER_OPTIONSW* pOptions)
#uselib "winspool.drv"
#cfunc global OpenPrinter2W "OpenPrinter2W" wstr, var, var, var
; res = OpenPrinter2W(pPrinterName, phPrinter, pDefault, pOptions)
; pPrinterName : LPCWSTR optional -> "wstr"
; phPrinter : PRINTER_HANDLE* out -> "var"
; pDefault : PRINTER_DEFAULTSW* optional -> "var"
; pOptions : PRINTER_OPTIONSW* optional -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	winspool_drv = windows.NewLazySystemDLL("winspool.drv")
	procOpenPrinter2W = winspool_drv.NewProc("OpenPrinter2W")
)

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

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

typedef OpenPrinter2WNative = Int32 Function(Pointer<Utf16>, Pointer<Void>, Pointer<Void>, Pointer<Void>);
typedef OpenPrinter2WDart = int Function(Pointer<Utf16>, Pointer<Void>, Pointer<Void>, Pointer<Void>);
final OpenPrinter2W = DynamicLibrary.open('winspool.drv')
    .lookupFunction<OpenPrinter2WNative, OpenPrinter2WDart>('OpenPrinter2W');
// pPrinterName : LPCWSTR optional -> Pointer<Utf16>
// phPrinter : PRINTER_HANDLE* out -> Pointer<Void>
// pDefault : PRINTER_DEFAULTSW* optional -> Pointer<Void>
// pOptions : PRINTER_OPTIONSW* optional -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function OpenPrinter2W(
  pPrinterName: PWideChar;   // LPCWSTR optional
  phPrinter: Pointer;   // PRINTER_HANDLE* out
  pDefault: Pointer;   // PRINTER_DEFAULTSW* optional
  pOptions: Pointer   // PRINTER_OPTIONSW* optional
): BOOL; stdcall;
  external 'winspool.drv' name 'OpenPrinter2W';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "OpenPrinter2W"
  c_OpenPrinter2W :: CWString -> Ptr () -> Ptr () -> Ptr () -> IO CInt
-- pPrinterName : LPCWSTR optional -> CWString
-- phPrinter : PRINTER_HANDLE* out -> Ptr ()
-- pDefault : PRINTER_DEFAULTSW* optional -> Ptr ()
-- pOptions : PRINTER_OPTIONSW* optional -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let openprinter2w =
  foreign "OpenPrinter2W"
    ((ptr uint16_t) @-> (ptr void) @-> (ptr void) @-> (ptr void) @-> returning int32_t)
(* pPrinterName : LPCWSTR optional -> (ptr uint16_t) *)
(* phPrinter : PRINTER_HANDLE* out -> (ptr void) *)
(* pDefault : PRINTER_DEFAULTSW* optional -> (ptr void) *)
(* pOptions : PRINTER_OPTIONSW* optional -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library winspool.drv (t "winspool.drv"))
(cffi:use-foreign-library winspool.drv)

(cffi:defcfun ("OpenPrinter2W" open-printer2-w :convention :stdcall) :int32
  (p-printer-name (:string :encoding :utf-16le))   ; LPCWSTR optional
  (ph-printer :pointer)   ; PRINTER_HANDLE* out
  (p-default :pointer)   ; PRINTER_DEFAULTSW* optional
  (p-options :pointer))   ; PRINTER_OPTIONSW* optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $OpenPrinter2W = Win32::API::More->new('winspool.drv',
    'BOOL OpenPrinter2W(LPCWSTR pPrinterName, LPVOID phPrinter, LPVOID pDefault, LPVOID pOptions)');
# my $ret = $OpenPrinter2W->Call($pPrinterName, $phPrinter, $pDefault, $pOptions);
# pPrinterName : LPCWSTR optional -> LPCWSTR
# phPrinter : PRINTER_HANDLE* out -> LPVOID
# pDefault : PRINTER_DEFAULTSW* optional -> LPVOID
# pOptions : PRINTER_OPTIONSW* optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

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