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

OpenPrinter2A

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

シグネチャ

// winspool.drv  (ANSI / -A)
#include <windows.h>

BOOL OpenPrinter2A(
    LPCSTR pPrinterName,   // optional
    PRINTER_HANDLE* phPrinter,
    PRINTER_DEFAULTSA* pDefault,   // optional
    PRINTER_OPTIONSA* pOptions   // optional
);

パラメーター

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

戻り値の型: BOOL

各言語での呼び出し定義

// winspool.drv  (ANSI / -A)
#include <windows.h>

BOOL OpenPrinter2A(
    LPCSTR pPrinterName,   // optional
    PRINTER_HANDLE* phPrinter,
    PRINTER_DEFAULTSA* pDefault,   // optional
    PRINTER_OPTIONSA* pOptions   // optional
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("winspool.drv", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool OpenPrinter2A(
    [MarshalAs(UnmanagedType.LPStr)] string pPrinterName,   // LPCSTR optional
    IntPtr phPrinter,   // PRINTER_HANDLE* out
    IntPtr pDefault,   // PRINTER_DEFAULTSA* optional
    IntPtr pOptions   // PRINTER_OPTIONSA* optional
);
<DllImport("winspool.drv", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function OpenPrinter2A(
    <MarshalAs(UnmanagedType.LPStr)> pPrinterName As String,   ' LPCSTR optional
    phPrinter As IntPtr,   ' PRINTER_HANDLE* out
    pDefault As IntPtr,   ' PRINTER_DEFAULTSA* optional
    pOptions As IntPtr   ' PRINTER_OPTIONSA* optional
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' pPrinterName : LPCSTR optional
' phPrinter : PRINTER_HANDLE* out
' pDefault : PRINTER_DEFAULTSA* optional
' pOptions : PRINTER_OPTIONSA* optional
Declare PtrSafe Function OpenPrinter2A Lib "winspool.drv" ( _
    ByVal pPrinterName As String, _
    ByVal phPrinter As LongPtr, _
    ByVal pDefault As LongPtr, _
    ByVal pOptions As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

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

lib = Fiddle.dlopen('winspool.drv')
OpenPrinter2A = Fiddle::Function.new(
  lib['OpenPrinter2A'],
  [
    Fiddle::TYPE_VOIDP,  # pPrinterName : LPCSTR optional
    Fiddle::TYPE_VOIDP,  # phPrinter : PRINTER_HANDLE* out
    Fiddle::TYPE_VOIDP,  # pDefault : PRINTER_DEFAULTSA* optional
    Fiddle::TYPE_VOIDP,  # pOptions : PRINTER_OPTIONSA* optional
  ],
  Fiddle::TYPE_INT)
#[link(name = "winspool.drv")]
extern "system" {
    fn OpenPrinter2A(
        pPrinterName: *const u8,  // LPCSTR optional
        phPrinter: *mut PRINTER_HANDLE,  // PRINTER_HANDLE* out
        pDefault: *mut PRINTER_DEFAULTSA,  // PRINTER_DEFAULTSA* optional
        pOptions: *mut PRINTER_OPTIONSA  // PRINTER_OPTIONSA* optional
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("winspool.drv", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern bool OpenPrinter2A([MarshalAs(UnmanagedType.LPStr)] string pPrinterName, IntPtr phPrinter, IntPtr pDefault, IntPtr pOptions);
"@
$api = Add-Type -MemberDefinition $sig -Name 'winspool.drv_OpenPrinter2A' -Namespace Win32 -PassThru
# $api::OpenPrinter2A(pPrinterName, phPrinter, pDefault, pOptions)
#uselib "winspool.drv"
#func global OpenPrinter2A "OpenPrinter2A" sptr, sptr, sptr, sptr
; OpenPrinter2A pPrinterName, varptr(phPrinter), varptr(pDefault), varptr(pOptions)   ; 戻り値は stat
; pPrinterName : LPCSTR optional -> "sptr"
; phPrinter : PRINTER_HANDLE* out -> "sptr"
; pDefault : PRINTER_DEFAULTSA* optional -> "sptr"
; pOptions : PRINTER_OPTIONSA* optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "winspool.drv"
#cfunc global OpenPrinter2A "OpenPrinter2A" str, var, var, var
; res = OpenPrinter2A(pPrinterName, phPrinter, pDefault, pOptions)
; pPrinterName : LPCSTR optional -> "str"
; phPrinter : PRINTER_HANDLE* out -> "var"
; pDefault : PRINTER_DEFAULTSA* optional -> "var"
; pOptions : PRINTER_OPTIONSA* optional -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL OpenPrinter2A(LPCSTR pPrinterName, PRINTER_HANDLE* phPrinter, PRINTER_DEFAULTSA* pDefault, PRINTER_OPTIONSA* pOptions)
#uselib "winspool.drv"
#cfunc global OpenPrinter2A "OpenPrinter2A" str, var, var, var
; res = OpenPrinter2A(pPrinterName, phPrinter, pDefault, pOptions)
; pPrinterName : LPCSTR optional -> "str"
; phPrinter : PRINTER_HANDLE* out -> "var"
; pDefault : PRINTER_DEFAULTSA* optional -> "var"
; pOptions : PRINTER_OPTIONSA* optional -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	winspool_drv = windows.NewLazySystemDLL("winspool.drv")
	procOpenPrinter2A = winspool_drv.NewProc("OpenPrinter2A")
)

// pPrinterName (LPCSTR optional), phPrinter (PRINTER_HANDLE* out), pDefault (PRINTER_DEFAULTSA* optional), pOptions (PRINTER_OPTIONSA* optional)
r1, _, err := procOpenPrinter2A.Call(
	uintptr(unsafe.Pointer(windows.BytePtrFromString(pPrinterName))),
	uintptr(phPrinter),
	uintptr(pDefault),
	uintptr(pOptions),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function OpenPrinter2A(
  pPrinterName: PAnsiChar;   // LPCSTR optional
  phPrinter: Pointer;   // PRINTER_HANDLE* out
  pDefault: Pointer;   // PRINTER_DEFAULTSA* optional
  pOptions: Pointer   // PRINTER_OPTIONSA* optional
): BOOL; stdcall;
  external 'winspool.drv' name 'OpenPrinter2A';
result := DllCall("winspool.drv\OpenPrinter2A"
    , "AStr", pPrinterName   ; LPCSTR optional
    , "Ptr", phPrinter   ; PRINTER_HANDLE* out
    , "Ptr", pDefault   ; PRINTER_DEFAULTSA* optional
    , "Ptr", pOptions   ; PRINTER_OPTIONSA* optional
    , "Int")   ; return: BOOL
●OpenPrinter2A(pPrinterName, phPrinter, pDefault, pOptions) = DLL("winspool.drv", "bool OpenPrinter2A(char*, void*, void*, void*)")
# 呼び出し: OpenPrinter2A(pPrinterName, phPrinter, pDefault, pOptions)
# pPrinterName : LPCSTR optional -> "char*"
# phPrinter : PRINTER_HANDLE* out -> "void*"
# pDefault : PRINTER_DEFAULTSA* optional -> "void*"
# pOptions : PRINTER_OPTIONSA* optional -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "winspool.drv" fn OpenPrinter2A(
    pPrinterName: [*c]const u8, // LPCSTR optional
    phPrinter: [*c]PRINTER_HANDLE, // PRINTER_HANDLE* out
    pDefault: [*c]PRINTER_DEFAULTSA, // PRINTER_DEFAULTSA* optional
    pOptions: [*c]PRINTER_OPTIONSA // PRINTER_OPTIONSA* optional
) callconv(std.os.windows.WINAPI) i32;
proc OpenPrinter2A(
    pPrinterName: cstring,  # LPCSTR optional
    phPrinter: ptr PRINTER_HANDLE,  # PRINTER_HANDLE* out
    pDefault: ptr PRINTER_DEFAULTSA,  # PRINTER_DEFAULTSA* optional
    pOptions: ptr PRINTER_OPTIONSA  # PRINTER_OPTIONSA* optional
): int32 {.importc: "OpenPrinter2A", stdcall, dynlib: "winspool.drv".}
pragma(lib, "winspool.drv");
extern(Windows)
int OpenPrinter2A(
    const(char)* pPrinterName,   // LPCSTR optional
    PRINTER_HANDLE* phPrinter,   // PRINTER_HANDLE* out
    PRINTER_DEFAULTSA* pDefault,   // PRINTER_DEFAULTSA* optional
    PRINTER_OPTIONSA* pOptions   // PRINTER_OPTIONSA* optional
);
ccall((:OpenPrinter2A, "winspool.drv"), stdcall, Int32,
      (Cstring, Ptr{PRINTER_HANDLE}, Ptr{PRINTER_DEFAULTSA}, Ptr{PRINTER_OPTIONSA}),
      pPrinterName, phPrinter, pDefault, pOptions)
# pPrinterName : LPCSTR optional -> Cstring
# phPrinter : PRINTER_HANDLE* out -> Ptr{PRINTER_HANDLE}
# pDefault : PRINTER_DEFAULTSA* optional -> Ptr{PRINTER_DEFAULTSA}
# pOptions : PRINTER_OPTIONSA* optional -> Ptr{PRINTER_OPTIONSA}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t OpenPrinter2A(
    const char* pPrinterName,
    void* phPrinter,
    void* pDefault,
    void* pOptions);
]]
local winspool.drv = ffi.load("winspool.drv")
-- winspool.drv.OpenPrinter2A(pPrinterName, phPrinter, pDefault, pOptions)
-- pPrinterName : LPCSTR optional
-- phPrinter : PRINTER_HANDLE* out
-- pDefault : PRINTER_DEFAULTSA* optional
-- pOptions : PRINTER_OPTIONSA* optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('winspool.drv');
const OpenPrinter2A = lib.func('__stdcall', 'OpenPrinter2A', 'int32_t', ['str', 'void *', 'void *', 'void *']);
// OpenPrinter2A(pPrinterName, phPrinter, pDefault, pOptions)
// pPrinterName : LPCSTR optional -> 'str'
// phPrinter : PRINTER_HANDLE* out -> 'void *'
// pDefault : PRINTER_DEFAULTSA* optional -> 'void *'
// pOptions : PRINTER_OPTIONSA* optional -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("winspool.drv", {
  OpenPrinter2A: { parameters: ["buffer", "pointer", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.OpenPrinter2A(pPrinterName, phPrinter, pDefault, pOptions)
// pPrinterName : LPCSTR optional -> "buffer"
// phPrinter : PRINTER_HANDLE* out -> "pointer"
// pDefault : PRINTER_DEFAULTSA* optional -> "pointer"
// pOptions : PRINTER_OPTIONSA* optional -> "pointer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t OpenPrinter2A(
    const char* pPrinterName,
    void* phPrinter,
    void* pDefault,
    void* pOptions);
C, "winspool.drv");
// $ffi->OpenPrinter2A(pPrinterName, phPrinter, pDefault, pOptions);
// pPrinterName : LPCSTR optional
// phPrinter : PRINTER_HANDLE* out
// pDefault : PRINTER_DEFAULTSA* optional
// pOptions : PRINTER_OPTIONSA* 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.ASCII_OPTIONS);
    boolean OpenPrinter2A(
        String pPrinterName,   // LPCSTR optional
        Pointer phPrinter,   // PRINTER_HANDLE* out
        Pointer pDefault,   // PRINTER_DEFAULTSA* optional
        Pointer pOptions   // PRINTER_OPTIONSA* optional
    );
}
@[Link("winspool.drv")]
lib Libwinspool.drv
  fun OpenPrinter2A = OpenPrinter2A(
    pPrinterName : UInt8*,   # LPCSTR optional
    phPrinter : PRINTER_HANDLE*,   # PRINTER_HANDLE* out
    pDefault : PRINTER_DEFAULTSA*,   # PRINTER_DEFAULTSA* optional
    pOptions : PRINTER_OPTIONSA*   # PRINTER_OPTIONSA* optional
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef OpenPrinter2ANative = Int32 Function(Pointer<Utf8>, Pointer<Void>, Pointer<Void>, Pointer<Void>);
typedef OpenPrinter2ADart = int Function(Pointer<Utf8>, Pointer<Void>, Pointer<Void>, Pointer<Void>);
final OpenPrinter2A = DynamicLibrary.open('winspool.drv')
    .lookupFunction<OpenPrinter2ANative, OpenPrinter2ADart>('OpenPrinter2A');
// pPrinterName : LPCSTR optional -> Pointer<Utf8>
// phPrinter : PRINTER_HANDLE* out -> Pointer<Void>
// pDefault : PRINTER_DEFAULTSA* optional -> Pointer<Void>
// pOptions : PRINTER_OPTIONSA* optional -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function OpenPrinter2A(
  pPrinterName: PAnsiChar;   // LPCSTR optional
  phPrinter: Pointer;   // PRINTER_HANDLE* out
  pDefault: Pointer;   // PRINTER_DEFAULTSA* optional
  pOptions: Pointer   // PRINTER_OPTIONSA* optional
): BOOL; stdcall;
  external 'winspool.drv' name 'OpenPrinter2A';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let openprinter2a =
  foreign "OpenPrinter2A"
    (string @-> (ptr void) @-> (ptr void) @-> (ptr void) @-> returning int32_t)
(* pPrinterName : LPCSTR optional -> string *)
(* phPrinter : PRINTER_HANDLE* out -> (ptr void) *)
(* pDefault : PRINTER_DEFAULTSA* optional -> (ptr void) *)
(* pOptions : PRINTER_OPTIONSA* 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 ("OpenPrinter2A" open-printer2-a :convention :stdcall) :int32
  (p-printer-name :string)   ; LPCSTR optional
  (ph-printer :pointer)   ; PRINTER_HANDLE* out
  (p-default :pointer)   ; PRINTER_DEFAULTSA* optional
  (p-options :pointer))   ; PRINTER_OPTIONSA* optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $OpenPrinter2A = Win32::API::More->new('winspool.drv',
    'BOOL OpenPrinter2A(LPCSTR pPrinterName, LPVOID phPrinter, LPVOID pDefault, LPVOID pOptions)');
# my $ret = $OpenPrinter2A->Call($pPrinterName, $phPrinter, $pDefault, $pOptions);
# pPrinterName : LPCSTR optional -> LPCSTR
# phPrinter : PRINTER_HANDLE* out -> LPVOID
# pDefault : PRINTER_DEFAULTSA* optional -> LPVOID
# pOptions : PRINTER_OPTIONSA* optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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