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 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)。