Win32 API 日本語リファレンス
ホームStorage.Xps › StartDocA

StartDocA

関数
印刷ジョブを開始する(ANSI版)。指定デバイスコンテキストで新しいドキュメントを開始する。
DLLGDI32.dll文字セットANSI (-A)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

// GDI32.dll  (ANSI / -A)
#include <windows.h>

INT StartDocA(
    HDC hdc,
    const DOCINFOA* lpdi
);

パラメーター

名前方向説明
hdcHDCin印刷を行うプリンターのデバイスコンテキストのハンドル。
lpdiDOCINFOA*inドキュメント名や出力ファイル等を格納したDOCINFOA構造体へのポインタ。印刷ジョブの開始情報を渡す。

戻り値の型: INT

各言語での呼び出し定義

// GDI32.dll  (ANSI / -A)
#include <windows.h>

INT StartDocA(
    HDC hdc,
    const DOCINFOA* lpdi
);
[DllImport("GDI32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int StartDocA(
    IntPtr hdc,   // HDC
    IntPtr lpdi   // DOCINFOA*
);
<DllImport("GDI32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function StartDocA(
    hdc As IntPtr,   ' HDC
    lpdi As IntPtr   ' DOCINFOA*
) As Integer
End Function
' hdc : HDC
' lpdi : DOCINFOA*
Declare PtrSafe Function StartDocA Lib "gdi32" ( _
    ByVal hdc As LongPtr, _
    ByVal lpdi As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

StartDocA = ctypes.windll.gdi32.StartDocA
StartDocA.restype = ctypes.c_int
StartDocA.argtypes = [
    wintypes.HANDLE,  # hdc : HDC
    ctypes.c_void_p,  # lpdi : DOCINFOA*
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('GDI32.dll')
StartDocA = Fiddle::Function.new(
  lib['StartDocA'],
  [
    Fiddle::TYPE_VOIDP,  # hdc : HDC
    Fiddle::TYPE_VOIDP,  # lpdi : DOCINFOA*
  ],
  Fiddle::TYPE_INT)
#[link(name = "gdi32")]
extern "system" {
    fn StartDocA(
        hdc: *mut core::ffi::c_void,  // HDC
        lpdi: *const DOCINFOA  // DOCINFOA*
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("GDI32.dll", CharSet = CharSet.Ansi)]
public static extern int StartDocA(IntPtr hdc, IntPtr lpdi);
"@
$api = Add-Type -MemberDefinition $sig -Name 'GDI32_StartDocA' -Namespace Win32 -PassThru
# $api::StartDocA(hdc, lpdi)
#uselib "GDI32.dll"
#func global StartDocA "StartDocA" sptr, sptr
; StartDocA hdc, varptr(lpdi)   ; 戻り値は stat
; hdc : HDC -> "sptr"
; lpdi : DOCINFOA* -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "GDI32.dll"
#cfunc global StartDocA "StartDocA" sptr, var
; res = StartDocA(hdc, lpdi)
; hdc : HDC -> "sptr"
; lpdi : DOCINFOA* -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; INT StartDocA(HDC hdc, DOCINFOA* lpdi)
#uselib "GDI32.dll"
#cfunc global StartDocA "StartDocA" intptr, var
; res = StartDocA(hdc, lpdi)
; hdc : HDC -> "intptr"
; lpdi : DOCINFOA* -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	gdi32 = windows.NewLazySystemDLL("GDI32.dll")
	procStartDocA = gdi32.NewProc("StartDocA")
)

// hdc (HDC), lpdi (DOCINFOA*)
r1, _, err := procStartDocA.Call(
	uintptr(hdc),
	uintptr(lpdi),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // INT
function StartDocA(
  hdc: THandle;   // HDC
  lpdi: Pointer   // DOCINFOA*
): Integer; stdcall;
  external 'GDI32.dll' name 'StartDocA';
result := DllCall("GDI32\StartDocA"
    , "Ptr", hdc   ; HDC
    , "Ptr", lpdi   ; DOCINFOA*
    , "Int")   ; return: INT
●StartDocA(hdc, lpdi) = DLL("GDI32.dll", "int StartDocA(void*, void*)")
# 呼び出し: StartDocA(hdc, lpdi)
# hdc : HDC -> "void*"
# lpdi : DOCINFOA* -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef StartDocANative = Int32 Function(Pointer<Void>, Pointer<Void>);
typedef StartDocADart = int Function(Pointer<Void>, Pointer<Void>);
final StartDocA = DynamicLibrary.open('GDI32.dll')
    .lookupFunction<StartDocANative, StartDocADart>('StartDocA');
// hdc : HDC -> Pointer<Void>
// lpdi : DOCINFOA* -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function StartDocA(
  hdc: THandle;   // HDC
  lpdi: Pointer   // DOCINFOA*
): Integer; stdcall;
  external 'GDI32.dll' name 'StartDocA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "StartDocA"
  c_StartDocA :: Ptr () -> Ptr () -> IO Int32
-- hdc : HDC -> Ptr ()
-- lpdi : DOCINFOA* -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let startdoca =
  foreign "StartDocA"
    ((ptr void) @-> (ptr void) @-> returning int32_t)
(* hdc : HDC -> (ptr void) *)
(* lpdi : DOCINFOA* -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library gdi32 (t "GDI32.dll"))
(cffi:use-foreign-library gdi32)

(cffi:defcfun ("StartDocA" start-doc-a :convention :stdcall) :int32
  (hdc :pointer)   ; HDC
  (lpdi :pointer))   ; DOCINFOA*
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $StartDocA = Win32::API::More->new('GDI32',
    'int StartDocA(HANDLE hdc, LPVOID lpdi)');
# my $ret = $StartDocA->Call($hdc, $lpdi);
# hdc : HDC -> HANDLE
# lpdi : DOCINFOA* -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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