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

StartDocPrinterA

関数
プリンタへの印刷ドキュメントの開始を通知する(ANSI版)。
DLLwinspool.drv文字セットANSI (-A)呼出規約winapi

シグネチャ

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

DWORD StartDocPrinterA(
    PRINTER_HANDLE hPrinter,
    DWORD Level,
    DOC_INFO_1A* pDocInfo
);

パラメーター

名前方向説明
hPrinterPRINTER_HANDLEin印刷を開始する対象プリンターのハンドル。
LevelDWORDinpDocInfoが指す構造体のバージョン。1を指定する。
pDocInfoDOC_INFO_1A*inドキュメント名や出力ファイル、データ型を格納したDOC_INFO_1構造体へのポインタ。

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD StartDocPrinterA(
    PRINTER_HANDLE hPrinter,
    DWORD Level,
    DOC_INFO_1A* pDocInfo
);
[DllImport("winspool.drv", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint StartDocPrinterA(
    PRINTER_HANDLE hPrinter,   // PRINTER_HANDLE
    uint Level,   // DWORD
    IntPtr pDocInfo   // DOC_INFO_1A*
);
<DllImport("winspool.drv", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function StartDocPrinterA(
    hPrinter As PRINTER_HANDLE,   ' PRINTER_HANDLE
    Level As UInteger,   ' DWORD
    pDocInfo As IntPtr   ' DOC_INFO_1A*
) As UInteger
End Function
' hPrinter : PRINTER_HANDLE
' Level : DWORD
' pDocInfo : DOC_INFO_1A*
Declare PtrSafe Function StartDocPrinterA Lib "winspool.drv" ( _
    ByVal hPrinter As LongPtr, _
    ByVal Level As Long, _
    ByVal pDocInfo As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

StartDocPrinterA = ctypes.windll.LoadLibrary("winspool.drv").StartDocPrinterA
StartDocPrinterA.restype = wintypes.DWORD
StartDocPrinterA.argtypes = [
    PRINTER_HANDLE,  # hPrinter : PRINTER_HANDLE
    wintypes.DWORD,  # Level : DWORD
    ctypes.c_void_p,  # pDocInfo : DOC_INFO_1A*
]
require 'fiddle'
require 'fiddle/import'

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

var (
	winspool_drv = windows.NewLazySystemDLL("winspool.drv")
	procStartDocPrinterA = winspool_drv.NewProc("StartDocPrinterA")
)

// hPrinter (PRINTER_HANDLE), Level (DWORD), pDocInfo (DOC_INFO_1A*)
r1, _, err := procStartDocPrinterA.Call(
	uintptr(hPrinter),
	uintptr(Level),
	uintptr(pDocInfo),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function StartDocPrinterA(
  hPrinter: PRINTER_HANDLE;   // PRINTER_HANDLE
  Level: DWORD;   // DWORD
  pDocInfo: Pointer   // DOC_INFO_1A*
): DWORD; stdcall;
  external 'winspool.drv' name 'StartDocPrinterA';
result := DllCall("winspool.drv\StartDocPrinterA"
    , "Ptr", hPrinter   ; PRINTER_HANDLE
    , "UInt", Level   ; DWORD
    , "Ptr", pDocInfo   ; DOC_INFO_1A*
    , "UInt")   ; return: DWORD
●StartDocPrinterA(hPrinter, Level, pDocInfo) = DLL("winspool.drv", "dword StartDocPrinterA(void*, dword, void*)")
# 呼び出し: StartDocPrinterA(hPrinter, Level, pDocInfo)
# hPrinter : PRINTER_HANDLE -> "void*"
# Level : DWORD -> "dword"
# pDocInfo : DOC_INFO_1A* -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef StartDocPrinterANative = Uint32 Function(PRINTER_HANDLE, Uint32, Pointer<Void>);
typedef StartDocPrinterADart = int Function(int, int, Pointer<Void>);
final StartDocPrinterA = DynamicLibrary.open('winspool.drv')
    .lookupFunction<StartDocPrinterANative, StartDocPrinterADart>('StartDocPrinterA');
// hPrinter : PRINTER_HANDLE -> PRINTER_HANDLE
// Level : DWORD -> Uint32
// pDocInfo : DOC_INFO_1A* -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function StartDocPrinterA(
  hPrinter: PRINTER_HANDLE;   // PRINTER_HANDLE
  Level: DWORD;   // DWORD
  pDocInfo: Pointer   // DOC_INFO_1A*
): DWORD; stdcall;
  external 'winspool.drv' name 'StartDocPrinterA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let startdocprintera =
  foreign "StartDocPrinterA"
    (PRINTER_HANDLE @-> uint32_t @-> (ptr void) @-> returning uint32_t)
(* hPrinter : PRINTER_HANDLE -> PRINTER_HANDLE *)
(* Level : DWORD -> uint32_t *)
(* pDocInfo : DOC_INFO_1A* -> (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 ("StartDocPrinterA" start-doc-printer-a :convention :stdcall) :uint32
  (h-printer (:struct printer-handle))   ; PRINTER_HANDLE
  (level :uint32)   ; DWORD
  (p-doc-info :pointer))   ; DOC_INFO_1A*
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $StartDocPrinterA = Win32::API::More->new('winspool.drv',
    'DWORD StartDocPrinterA(LPVOID hPrinter, DWORD Level, LPVOID pDocInfo)');
# my $ret = $StartDocPrinterA->Call($hPrinter, $Level, $pDocInfo);
# hPrinter : PRINTER_HANDLE -> LPVOID
# Level : DWORD -> DWORD
# pDocInfo : DOC_INFO_1A* -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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