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

FlushPrinter

関数
プリンタへバッファのデータを送出し指定時間停止する。
DLLwinspool.drv呼出規約winapi

シグネチャ

// winspool.drv
#include <windows.h>

BOOL FlushPrinter(
    PRINTER_HANDLE hPrinter,
    void* pBuf,   // optional
    DWORD cbBuf,
    DWORD* pcWritten,
    DWORD cSleep
);

パラメーター

名前方向説明
hPrinterPRINTER_HANDLEin対象プリンターのハンドル。双方向ポートのリセットに用いる。
pBufvoid*inoptionalポートへ送出するデータを格納したバッファへのポインタ。
cbBufDWORDin送出するデータのサイズ(バイト単位)。
pcWrittenDWORD*out実際に書き込まれたバイト数を受け取る変数へのポインタ。
cSleepDWORDin書き込み後にポートをアイドル保持するスリープ時間(ミリ秒)。

戻り値の型: BOOL

各言語での呼び出し定義

// winspool.drv
#include <windows.h>

BOOL FlushPrinter(
    PRINTER_HANDLE hPrinter,
    void* pBuf,   // optional
    DWORD cbBuf,
    DWORD* pcWritten,
    DWORD cSleep
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("winspool.drv", ExactSpelling = true)]
static extern bool FlushPrinter(
    PRINTER_HANDLE hPrinter,   // PRINTER_HANDLE
    IntPtr pBuf,   // void* optional
    uint cbBuf,   // DWORD
    out uint pcWritten,   // DWORD* out
    uint cSleep   // DWORD
);
<DllImport("winspool.drv", ExactSpelling:=True)>
Public Shared Function FlushPrinter(
    hPrinter As PRINTER_HANDLE,   ' PRINTER_HANDLE
    pBuf As IntPtr,   ' void* optional
    cbBuf As UInteger,   ' DWORD
    <Out> ByRef pcWritten As UInteger,   ' DWORD* out
    cSleep As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' hPrinter : PRINTER_HANDLE
' pBuf : void* optional
' cbBuf : DWORD
' pcWritten : DWORD* out
' cSleep : DWORD
Declare PtrSafe Function FlushPrinter Lib "winspool.drv" ( _
    ByVal hPrinter As LongPtr, _
    ByVal pBuf As LongPtr, _
    ByVal cbBuf As Long, _
    ByRef pcWritten As Long, _
    ByVal cSleep As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

FlushPrinter = ctypes.windll.LoadLibrary("winspool.drv").FlushPrinter
FlushPrinter.restype = wintypes.BOOL
FlushPrinter.argtypes = [
    PRINTER_HANDLE,  # hPrinter : PRINTER_HANDLE
    ctypes.POINTER(None),  # pBuf : void* optional
    wintypes.DWORD,  # cbBuf : DWORD
    ctypes.POINTER(wintypes.DWORD),  # pcWritten : DWORD* out
    wintypes.DWORD,  # cSleep : DWORD
]
require 'fiddle'
require 'fiddle/import'

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

var (
	winspool_drv = windows.NewLazySystemDLL("winspool.drv")
	procFlushPrinter = winspool_drv.NewProc("FlushPrinter")
)

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

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

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

let flushprinter =
  foreign "FlushPrinter"
    (PRINTER_HANDLE @-> (ptr void) @-> uint32_t @-> (ptr uint32_t) @-> uint32_t @-> returning int32_t)
(* hPrinter : PRINTER_HANDLE -> PRINTER_HANDLE *)
(* pBuf : void* optional -> (ptr void) *)
(* cbBuf : DWORD -> uint32_t *)
(* pcWritten : DWORD* out -> (ptr uint32_t) *)
(* cSleep : 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 ("FlushPrinter" flush-printer :convention :stdcall) :int32
  (h-printer (:struct printer-handle))   ; PRINTER_HANDLE
  (p-buf :pointer)   ; void* optional
  (cb-buf :uint32)   ; DWORD
  (pc-written :pointer)   ; DWORD* out
  (c-sleep :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $FlushPrinter = Win32::API::More->new('winspool.drv',
    'BOOL FlushPrinter(LPVOID hPrinter, LPVOID pBuf, DWORD cbBuf, LPVOID pcWritten, DWORD cSleep)');
# my $ret = $FlushPrinter->Call($hPrinter, $pBuf, $cbBuf, $pcWritten, $cSleep);
# hPrinter : PRINTER_HANDLE -> LPVOID
# pBuf : void* optional -> LPVOID
# cbBuf : DWORD -> DWORD
# pcWritten : DWORD* out -> LPVOID
# cSleep : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型