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

DocumentPropertiesA

関数
ドキュメントの印刷設定を取得・編集する(ANSI版)。
DLLwinspool.drv文字セットANSI (-A)呼出規約winapi
📘 Microsoft Learn (日本語) · English

シグネチャ

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

INT DocumentPropertiesA(
    HWND hWnd,   // optional
    PRINTER_HANDLE hPrinter,
    LPSTR pDeviceName,
    DEVMODEA* pDevModeOutput,   // optional
    DEVMODEA* pDevModeInput,   // optional
    DWORD fMode
);

パラメーター

名前型方向説明
hWndHWNDinoptionalダイアログ表示時の親ウィンドウのハンドル。
hPrinterPRINTER_HANDLEin対象プリンターのハンドル。
pDeviceNameLPSTRin対象デバイス名(プリンター名)を指すポインタ。
pDevModeOutputDEVMODEA*outoptional更新後のDEVMODEを受け取るバッファへのポインタ。サイズ照会時はNULL可。
pDevModeInputDEVMODEA*inoptional初期値として渡すDEVMODE構造体へのポインタ。NULL可。
fModeDWORDin動作モードを示すフラグ。DM_OUT_BUFFer、DM_IN_PROMPT等を組み合わせる。

戻り値の型: INT

各言語での呼び出し定義

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

INT DocumentPropertiesA(
    HWND hWnd,   // optional
    PRINTER_HANDLE hPrinter,
    LPSTR pDeviceName,
    DEVMODEA* pDevModeOutput,   // optional
    DEVMODEA* pDevModeInput,   // optional
    DWORD fMode
);
[DllImport("winspool.drv", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int DocumentPropertiesA(
    IntPtr hWnd,   // HWND optional
    PRINTER_HANDLE hPrinter,   // PRINTER_HANDLE
    [MarshalAs(UnmanagedType.LPStr)] string pDeviceName,   // LPSTR
    IntPtr pDevModeOutput,   // DEVMODEA* optional, out
    IntPtr pDevModeInput,   // DEVMODEA* optional
    uint fMode   // DWORD
);
<DllImport("winspool.drv", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function DocumentPropertiesA(
    hWnd As IntPtr,   ' HWND optional
    hPrinter As PRINTER_HANDLE,   ' PRINTER_HANDLE
    <MarshalAs(UnmanagedType.LPStr)> pDeviceName As String,   ' LPSTR
    pDevModeOutput As IntPtr,   ' DEVMODEA* optional, out
    pDevModeInput As IntPtr,   ' DEVMODEA* optional
    fMode As UInteger   ' DWORD
) As Integer
End Function
' hWnd : HWND optional
' hPrinter : PRINTER_HANDLE
' pDeviceName : LPSTR
' pDevModeOutput : DEVMODEA* optional, out
' pDevModeInput : DEVMODEA* optional
' fMode : DWORD
Declare PtrSafe Function DocumentPropertiesA Lib "winspool.drv" ( _
    ByVal hWnd As LongPtr, _
    ByVal hPrinter As LongPtr, _
    ByVal pDeviceName As String, _
    ByVal pDevModeOutput As LongPtr, _
    ByVal pDevModeInput As LongPtr, _
    ByVal fMode As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

DocumentPropertiesA = ctypes.windll.LoadLibrary("winspool.drv").DocumentPropertiesA
DocumentPropertiesA.restype = ctypes.c_int
DocumentPropertiesA.argtypes = [
    wintypes.HANDLE,  # hWnd : HWND optional
    PRINTER_HANDLE,  # hPrinter : PRINTER_HANDLE
    wintypes.LPCSTR,  # pDeviceName : LPSTR
    ctypes.c_void_p,  # pDevModeOutput : DEVMODEA* optional, out
    ctypes.c_void_p,  # pDevModeInput : DEVMODEA* optional
    wintypes.DWORD,  # fMode : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('winspool.drv')
DocumentPropertiesA = Fiddle::Function.new(
  lib['DocumentPropertiesA'],
  [
    Fiddle::TYPE_VOIDP,  # hWnd : HWND optional
    Fiddle::TYPE_VOIDP,  # hPrinter : PRINTER_HANDLE
    Fiddle::TYPE_VOIDP,  # pDeviceName : LPSTR
    Fiddle::TYPE_VOIDP,  # pDevModeOutput : DEVMODEA* optional, out
    Fiddle::TYPE_VOIDP,  # pDevModeInput : DEVMODEA* optional
    -Fiddle::TYPE_INT,  # fMode : DWORD
  ],
  Fiddle::TYPE_INT)
#[link(name = "winspool.drv")]
extern "system" {
    fn DocumentPropertiesA(
        hWnd: *mut core::ffi::c_void,  // HWND optional
        hPrinter: PRINTER_HANDLE,  // PRINTER_HANDLE
        pDeviceName: *mut u8,  // LPSTR
        pDevModeOutput: *mut DEVMODEA,  // DEVMODEA* optional, out
        pDevModeInput: *mut DEVMODEA,  // DEVMODEA* optional
        fMode: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("winspool.drv", CharSet = CharSet.Ansi)]
public static extern int DocumentPropertiesA(IntPtr hWnd, PRINTER_HANDLE hPrinter, [MarshalAs(UnmanagedType.LPStr)] string pDeviceName, IntPtr pDevModeOutput, IntPtr pDevModeInput, uint fMode);
"@
$api = Add-Type -MemberDefinition $sig -Name 'winspool.drv_DocumentPropertiesA' -Namespace Win32 -PassThru
# $api::DocumentPropertiesA(hWnd, hPrinter, pDeviceName, pDevModeOutput, pDevModeInput, fMode)
#uselib "winspool.drv"
#func global DocumentPropertiesA "DocumentPropertiesA" sptr, sptr, sptr, sptr, sptr, sptr
; DocumentPropertiesA hWnd, hPrinter, pDeviceName, varptr(pDevModeOutput), varptr(pDevModeInput), fMode   ; 戻り値は stat
; hWnd : HWND optional -> "sptr"
; hPrinter : PRINTER_HANDLE -> "sptr"
; pDeviceName : LPSTR -> "sptr"
; pDevModeOutput : DEVMODEA* optional, out -> "sptr"
; pDevModeInput : DEVMODEA* optional -> "sptr"
; fMode : DWORD -> "sptr"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数: 
#uselib "winspool.drv"
#cfunc global DocumentPropertiesA "DocumentPropertiesA" sptr, int, str, var, var, int
; res = DocumentPropertiesA(hWnd, hPrinter, pDeviceName, pDevModeOutput, pDevModeInput, fMode)
; hWnd : HWND optional -> "sptr"
; hPrinter : PRINTER_HANDLE -> "int"
; pDeviceName : LPSTR -> "str"
; pDevModeOutput : DEVMODEA* optional, out -> "var"
; pDevModeInput : DEVMODEA* optional -> "var"
; fMode : DWORD -> "int"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数: 
; INT DocumentPropertiesA(HWND hWnd, PRINTER_HANDLE hPrinter, LPSTR pDeviceName, DEVMODEA* pDevModeOutput, DEVMODEA* pDevModeInput, DWORD fMode)
#uselib "winspool.drv"
#cfunc global DocumentPropertiesA "DocumentPropertiesA" intptr, int, str, var, var, int
; res = DocumentPropertiesA(hWnd, hPrinter, pDeviceName, pDevModeOutput, pDevModeInput, fMode)
; hWnd : HWND optional -> "intptr"
; hPrinter : PRINTER_HANDLE -> "int"
; pDeviceName : LPSTR -> "str"
; pDevModeOutput : DEVMODEA* optional, out -> "var"
; pDevModeInput : DEVMODEA* optional -> "var"
; fMode : DWORD -> "int"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	winspool_drv = windows.NewLazySystemDLL("winspool.drv")
	procDocumentPropertiesA = winspool_drv.NewProc("DocumentPropertiesA")
)

// hWnd (HWND optional), hPrinter (PRINTER_HANDLE), pDeviceName (LPSTR), pDevModeOutput (DEVMODEA* optional, out), pDevModeInput (DEVMODEA* optional), fMode (DWORD)
r1, _, err := procDocumentPropertiesA.Call(
	uintptr(hWnd),
	uintptr(hPrinter),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(pDeviceName))),
	uintptr(pDevModeOutput),
	uintptr(pDevModeInput),
	uintptr(fMode),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // INT
function DocumentPropertiesA(
  hWnd: THandle;   // HWND optional
  hPrinter: PRINTER_HANDLE;   // PRINTER_HANDLE
  pDeviceName: PAnsiChar;   // LPSTR
  pDevModeOutput: Pointer;   // DEVMODEA* optional, out
  pDevModeInput: Pointer;   // DEVMODEA* optional
  fMode: DWORD   // DWORD
): Integer; stdcall;
  external 'winspool.drv' name 'DocumentPropertiesA';
result := DllCall("winspool.drv\DocumentPropertiesA"
    , "Ptr", hWnd   ; HWND optional
    , "Ptr", hPrinter   ; PRINTER_HANDLE
    , "AStr", pDeviceName   ; LPSTR
    , "Ptr", pDevModeOutput   ; DEVMODEA* optional, out
    , "Ptr", pDevModeInput   ; DEVMODEA* optional
    , "UInt", fMode   ; DWORD
    , "Int")   ; return: INT
●DocumentPropertiesA(hWnd, hPrinter, pDeviceName, pDevModeOutput, pDevModeInput, fMode) = DLL("winspool.drv", "int DocumentPropertiesA(void*, void*, char*, void*, void*, dword)")
# 呼び出し: DocumentPropertiesA(hWnd, hPrinter, pDeviceName, pDevModeOutput, pDevModeInput, fMode)
# hWnd : HWND optional -> "void*"
# hPrinter : PRINTER_HANDLE -> "void*"
# pDeviceName : LPSTR -> "char*"
# pDevModeOutput : DEVMODEA* optional, out -> "void*"
# pDevModeInput : DEVMODEA* optional -> "void*"
# fMode : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "winspool.drv" fn DocumentPropertiesA(
    hWnd: ?*anyopaque, // HWND optional
    hPrinter: PRINTER_HANDLE, // PRINTER_HANDLE
    pDeviceName: [*c]const u8, // LPSTR
    pDevModeOutput: [*c]DEVMODEA, // DEVMODEA* optional, out
    pDevModeInput: [*c]DEVMODEA, // DEVMODEA* optional
    fMode: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
proc DocumentPropertiesA(
    hWnd: pointer,  # HWND optional
    hPrinter: PRINTER_HANDLE,  # PRINTER_HANDLE
    pDeviceName: cstring,  # LPSTR
    pDevModeOutput: ptr DEVMODEA,  # DEVMODEA* optional, out
    pDevModeInput: ptr DEVMODEA,  # DEVMODEA* optional
    fMode: uint32  # DWORD
): int32 {.importc: "DocumentPropertiesA", stdcall, dynlib: "winspool.drv".}
pragma(lib, "winspool.drv");
extern(Windows)
int DocumentPropertiesA(
    void* hWnd,   // HWND optional
    PRINTER_HANDLE hPrinter,   // PRINTER_HANDLE
    const(char)* pDeviceName,   // LPSTR
    DEVMODEA* pDevModeOutput,   // DEVMODEA* optional, out
    DEVMODEA* pDevModeInput,   // DEVMODEA* optional
    uint fMode   // DWORD
);
ccall((:DocumentPropertiesA, "winspool.drv"), stdcall, Int32,
      (Ptr{Cvoid}, PRINTER_HANDLE, Cstring, Ptr{DEVMODEA}, Ptr{DEVMODEA}, UInt32),
      hWnd, hPrinter, pDeviceName, pDevModeOutput, pDevModeInput, fMode)
# hWnd : HWND optional -> Ptr{Cvoid}
# hPrinter : PRINTER_HANDLE -> PRINTER_HANDLE
# pDeviceName : LPSTR -> Cstring
# pDevModeOutput : DEVMODEA* optional, out -> Ptr{DEVMODEA}
# pDevModeInput : DEVMODEA* optional -> Ptr{DEVMODEA}
# fMode : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t DocumentPropertiesA(
    void* hWnd,
    PRINTER_HANDLE hPrinter,
    const char* pDeviceName,
    void* pDevModeOutput,
    void* pDevModeInput,
    uint32_t fMode);
]]
local winspool.drv = ffi.load("winspool.drv")
-- winspool.drv.DocumentPropertiesA(hWnd, hPrinter, pDeviceName, pDevModeOutput, pDevModeInput, fMode)
-- hWnd : HWND optional
-- hPrinter : PRINTER_HANDLE
-- pDeviceName : LPSTR
-- pDevModeOutput : DEVMODEA* optional, out
-- pDevModeInput : DEVMODEA* optional
-- fMode : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('winspool.drv');
const DocumentPropertiesA = lib.func('__stdcall', 'DocumentPropertiesA', 'int32_t', ['void *', 'PRINTER_HANDLE', 'str', 'void *', 'void *', 'uint32_t']);
// DocumentPropertiesA(hWnd, hPrinter, pDeviceName, pDevModeOutput, pDevModeInput, fMode)
// hWnd : HWND optional -> 'void *'
// hPrinter : PRINTER_HANDLE -> 'PRINTER_HANDLE'
// pDeviceName : LPSTR -> 'str'
// pDevModeOutput : DEVMODEA* optional, out -> 'void *'
// pDevModeInput : DEVMODEA* optional -> 'void *'
// fMode : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("winspool.drv", {
  DocumentPropertiesA: { parameters: ["pointer", "buffer", "buffer", "pointer", "pointer", "u32"], result: "i32" },
});
// lib.symbols.DocumentPropertiesA(hWnd, hPrinter, pDeviceName, pDevModeOutput, pDevModeInput, fMode)
// hWnd : HWND optional -> "pointer"
// hPrinter : PRINTER_HANDLE -> "buffer"
// pDeviceName : LPSTR -> "buffer"
// pDevModeOutput : DEVMODEA* optional, out -> "pointer"
// pDevModeInput : DEVMODEA* optional -> "pointer"
// fMode : DWORD -> "u32"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t DocumentPropertiesA(
    void* hWnd,
    PRINTER_HANDLE hPrinter,
    const char* pDeviceName,
    void* pDevModeOutput,
    void* pDevModeInput,
    uint32_t fMode);
C, "winspool.drv");
// $ffi->DocumentPropertiesA(hWnd, hPrinter, pDeviceName, pDevModeOutput, pDevModeInput, fMode);
// hWnd : HWND optional
// hPrinter : PRINTER_HANDLE
// pDeviceName : LPSTR
// pDevModeOutput : DEVMODEA* optional, out
// pDevModeInput : DEVMODEA* optional
// fMode : 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.ASCII_OPTIONS);
    int DocumentPropertiesA(
        Pointer hWnd,   // HWND optional
        PRINTER_HANDLE /* extends Structure (by value) */ hPrinter,   // PRINTER_HANDLE
        String pDeviceName,   // LPSTR
        Pointer pDevModeOutput,   // DEVMODEA* optional, out
        Pointer pDevModeInput,   // DEVMODEA* optional
        int fMode   // DWORD
    );
}
@[Link("winspool.drv")]
lib Libwinspool.drv
  fun DocumentPropertiesA = DocumentPropertiesA(
    hWnd : Void*,   # HWND optional
    hPrinter : PRINTER_HANDLE,   # PRINTER_HANDLE
    pDeviceName : UInt8*,   # LPSTR
    pDevModeOutput : DEVMODEA*,   # DEVMODEA* optional, out
    pDevModeInput : DEVMODEA*,   # DEVMODEA* optional
    fMode : 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 DocumentPropertiesANative = Int32 Function(Pointer<Void>, PRINTER_HANDLE, Pointer<Utf8>, Pointer<Void>, Pointer<Void>, Uint32);
typedef DocumentPropertiesADart = int Function(Pointer<Void>, int, Pointer<Utf8>, Pointer<Void>, Pointer<Void>, int);
final DocumentPropertiesA = DynamicLibrary.open('winspool.drv')
    .lookupFunction<DocumentPropertiesANative, DocumentPropertiesADart>('DocumentPropertiesA');
// hWnd : HWND optional -> Pointer<Void>
// hPrinter : PRINTER_HANDLE -> PRINTER_HANDLE
// pDeviceName : LPSTR -> Pointer<Utf8>
// pDevModeOutput : DEVMODEA* optional, out -> Pointer<Void>
// pDevModeInput : DEVMODEA* optional -> Pointer<Void>
// fMode : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function DocumentPropertiesA(
  hWnd: THandle;   // HWND optional
  hPrinter: PRINTER_HANDLE;   // PRINTER_HANDLE
  pDeviceName: PAnsiChar;   // LPSTR
  pDevModeOutput: Pointer;   // DEVMODEA* optional, out
  pDevModeInput: Pointer;   // DEVMODEA* optional
  fMode: DWORD   // DWORD
): Integer; stdcall;
  external 'winspool.drv' name 'DocumentPropertiesA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "DocumentPropertiesA"
  c_DocumentPropertiesA :: Ptr () -> PRINTER_HANDLE -> CString -> Ptr () -> Ptr () -> Word32 -> IO Int32
-- hWnd : HWND optional -> Ptr ()
-- hPrinter : PRINTER_HANDLE -> PRINTER_HANDLE
-- pDeviceName : LPSTR -> CString
-- pDevModeOutput : DEVMODEA* optional, out -> Ptr ()
-- pDevModeInput : DEVMODEA* optional -> Ptr ()
-- fMode : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
-- ※値渡し構造体は GHC FFI で直接渡せません。Ptr で渡すラッパ(C側)経由にしてください。
open Ctypes
open Foreign

let documentpropertiesa =
  foreign "DocumentPropertiesA"
    ((ptr void) @-> PRINTER_HANDLE @-> string @-> (ptr void) @-> (ptr void) @-> uint32_t @-> returning int32_t)
(* hWnd : HWND optional -> (ptr void) *)
(* hPrinter : PRINTER_HANDLE -> PRINTER_HANDLE *)
(* pDeviceName : LPSTR -> string *)
(* pDevModeOutput : DEVMODEA* optional, out -> (ptr void) *)
(* pDevModeInput : DEVMODEA* optional -> (ptr void) *)
(* fMode : 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 ("DocumentPropertiesA" document-properties-a :convention :stdcall) :int32
  (h-wnd :pointer)   ; HWND optional
  (h-printer (:struct printer-handle))   ; PRINTER_HANDLE
  (p-device-name :string)   ; LPSTR
  (p-dev-mode-output :pointer)   ; DEVMODEA* optional, out
  (p-dev-mode-input :pointer)   ; DEVMODEA* optional
  (f-mode :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $DocumentPropertiesA = Win32::API::More->new('winspool.drv',
    'int DocumentPropertiesA(HANDLE hWnd, LPVOID hPrinter, LPCSTR pDeviceName, LPVOID pDevModeOutput, LPVOID pDevModeInput, DWORD fMode)');
# my $ret = $DocumentPropertiesA->Call($hWnd, $hPrinter, $pDeviceName, $pDevModeOutput, $pDevModeInput, $fMode);
# hWnd : HWND optional -> HANDLE
# hPrinter : PRINTER_HANDLE -> LPVOID
# pDeviceName : LPSTR -> LPCSTR
# pDevModeOutput : DEVMODEA* optional, out -> LPVOID
# pDevModeInput : DEVMODEA* optional -> LPVOID
# fMode : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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