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

GetDefaultPrinterW

関数
既定のプリンター名を取得する。
DLLwinspool.drv文字セットUnicode (-W)呼出規約winapi

シグネチャ

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

BOOL GetDefaultPrinterW(
    LPWSTR pszBuffer,   // optional
    DWORD* pcchBuffer
);

パラメーター

名前方向説明
pszBufferLPWSTRoutoptional既定プリンター名を受け取るバッファへのポインタ。
pcchBufferDWORD*inout入力時はバッファの文字数、出力時は必要文字数を受け取る変数へのポインタ。

戻り値の型: BOOL

各言語での呼び出し定義

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

BOOL GetDefaultPrinterW(
    LPWSTR pszBuffer,   // optional
    DWORD* pcchBuffer
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("winspool.drv", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern bool GetDefaultPrinterW(
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pszBuffer,   // LPWSTR optional, out
    ref uint pcchBuffer   // DWORD* in/out
);
<DllImport("winspool.drv", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function GetDefaultPrinterW(
    <MarshalAs(UnmanagedType.LPWStr)> pszBuffer As System.Text.StringBuilder,   ' LPWSTR optional, out
    ByRef pcchBuffer As UInteger   ' DWORD* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' pszBuffer : LPWSTR optional, out
' pcchBuffer : DWORD* in/out
Declare PtrSafe Function GetDefaultPrinterW Lib "winspool.drv" ( _
    ByVal pszBuffer As LongPtr, _
    ByRef pcchBuffer 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

GetDefaultPrinterW = ctypes.windll.LoadLibrary("winspool.drv").GetDefaultPrinterW
GetDefaultPrinterW.restype = wintypes.BOOL
GetDefaultPrinterW.argtypes = [
    wintypes.LPWSTR,  # pszBuffer : LPWSTR optional, out
    ctypes.POINTER(wintypes.DWORD),  # pcchBuffer : DWORD* in/out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	winspool_drv = windows.NewLazySystemDLL("winspool.drv")
	procGetDefaultPrinterW = winspool_drv.NewProc("GetDefaultPrinterW")
)

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

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

typedef GetDefaultPrinterWNative = Int32 Function(Pointer<Utf16>, Pointer<Uint32>);
typedef GetDefaultPrinterWDart = int Function(Pointer<Utf16>, Pointer<Uint32>);
final GetDefaultPrinterW = DynamicLibrary.open('winspool.drv')
    .lookupFunction<GetDefaultPrinterWNative, GetDefaultPrinterWDart>('GetDefaultPrinterW');
// pszBuffer : LPWSTR optional, out -> Pointer<Utf16>
// pcchBuffer : DWORD* in/out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetDefaultPrinterW(
  pszBuffer: PWideChar;   // LPWSTR optional, out
  pcchBuffer: Pointer   // DWORD* in/out
): BOOL; stdcall;
  external 'winspool.drv' name 'GetDefaultPrinterW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "GetDefaultPrinterW"
  c_GetDefaultPrinterW :: CWString -> Ptr Word32 -> IO CInt
-- pszBuffer : LPWSTR optional, out -> CWString
-- pcchBuffer : DWORD* in/out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let getdefaultprinterw =
  foreign "GetDefaultPrinterW"
    ((ptr uint16_t) @-> (ptr uint32_t) @-> returning int32_t)
(* pszBuffer : LPWSTR optional, out -> (ptr uint16_t) *)
(* pcchBuffer : DWORD* in/out -> (ptr 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 ("GetDefaultPrinterW" get-default-printer-w :convention :stdcall) :int32
  (psz-buffer :pointer)   ; LPWSTR optional, out
  (pcch-buffer :pointer))   ; DWORD* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetDefaultPrinterW = Win32::API::More->new('winspool.drv',
    'BOOL GetDefaultPrinterW(LPWSTR pszBuffer, LPVOID pcchBuffer)');
# my $ret = $GetDefaultPrinterW->Call($pszBuffer, $pcchBuffer);
# pszBuffer : LPWSTR optional, out -> LPWSTR
# pcchBuffer : DWORD* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い