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

ReportJobProcessingProgress

関数
XPS印刷ジョブの処理進捗をスプーラーへ報告する。
DLLwinspool.drv呼出規約winapi

シグネチャ

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

HRESULT ReportJobProcessingProgress(
    HANDLE printerHandle,
    DWORD jobId,
    EPrintXPSJobOperation jobOperation,
    EPrintXPSJobProgress jobProgress
);

パラメーター

名前方向説明
printerHandleHANDLEinOpenPrinterで取得したプリンタハンドル。対象ジョブを保持する。
jobIdDWORDin進捗を報告する印刷ジョブの識別子。
jobOperationEPrintXPSJobOperationin実行中のXPSジョブ操作種別を示すEPrintXPSJobOperation列挙値。
jobProgressEPrintXPSJobProgressin現在のジョブ進捗段階を示すEPrintXPSJobProgress列挙値。

戻り値の型: HRESULT

各言語での呼び出し定義

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

HRESULT ReportJobProcessingProgress(
    HANDLE printerHandle,
    DWORD jobId,
    EPrintXPSJobOperation jobOperation,
    EPrintXPSJobProgress jobProgress
);
[DllImport("winspool.drv", ExactSpelling = true)]
static extern int ReportJobProcessingProgress(
    IntPtr printerHandle,   // HANDLE
    uint jobId,   // DWORD
    int jobOperation,   // EPrintXPSJobOperation
    int jobProgress   // EPrintXPSJobProgress
);
<DllImport("winspool.drv", ExactSpelling:=True)>
Public Shared Function ReportJobProcessingProgress(
    printerHandle As IntPtr,   ' HANDLE
    jobId As UInteger,   ' DWORD
    jobOperation As Integer,   ' EPrintXPSJobOperation
    jobProgress As Integer   ' EPrintXPSJobProgress
) As Integer
End Function
' printerHandle : HANDLE
' jobId : DWORD
' jobOperation : EPrintXPSJobOperation
' jobProgress : EPrintXPSJobProgress
Declare PtrSafe Function ReportJobProcessingProgress Lib "winspool.drv" ( _
    ByVal printerHandle As LongPtr, _
    ByVal jobId As Long, _
    ByVal jobOperation As Long, _
    ByVal jobProgress As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

ReportJobProcessingProgress = ctypes.windll.LoadLibrary("winspool.drv").ReportJobProcessingProgress
ReportJobProcessingProgress.restype = ctypes.c_int
ReportJobProcessingProgress.argtypes = [
    wintypes.HANDLE,  # printerHandle : HANDLE
    wintypes.DWORD,  # jobId : DWORD
    ctypes.c_int,  # jobOperation : EPrintXPSJobOperation
    ctypes.c_int,  # jobProgress : EPrintXPSJobProgress
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('winspool.drv')
ReportJobProcessingProgress = Fiddle::Function.new(
  lib['ReportJobProcessingProgress'],
  [
    Fiddle::TYPE_VOIDP,  # printerHandle : HANDLE
    -Fiddle::TYPE_INT,  # jobId : DWORD
    Fiddle::TYPE_INT,  # jobOperation : EPrintXPSJobOperation
    Fiddle::TYPE_INT,  # jobProgress : EPrintXPSJobProgress
  ],
  Fiddle::TYPE_INT)
#[link(name = "winspool.drv")]
extern "system" {
    fn ReportJobProcessingProgress(
        printerHandle: *mut core::ffi::c_void,  // HANDLE
        jobId: u32,  // DWORD
        jobOperation: i32,  // EPrintXPSJobOperation
        jobProgress: i32  // EPrintXPSJobProgress
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("winspool.drv")]
public static extern int ReportJobProcessingProgress(IntPtr printerHandle, uint jobId, int jobOperation, int jobProgress);
"@
$api = Add-Type -MemberDefinition $sig -Name 'winspool.drv_ReportJobProcessingProgress' -Namespace Win32 -PassThru
# $api::ReportJobProcessingProgress(printerHandle, jobId, jobOperation, jobProgress)
#uselib "winspool.drv"
#func global ReportJobProcessingProgress "ReportJobProcessingProgress" sptr, sptr, sptr, sptr
; ReportJobProcessingProgress printerHandle, jobId, jobOperation, jobProgress   ; 戻り値は stat
; printerHandle : HANDLE -> "sptr"
; jobId : DWORD -> "sptr"
; jobOperation : EPrintXPSJobOperation -> "sptr"
; jobProgress : EPrintXPSJobProgress -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "winspool.drv"
#cfunc global ReportJobProcessingProgress "ReportJobProcessingProgress" sptr, int, int, int
; res = ReportJobProcessingProgress(printerHandle, jobId, jobOperation, jobProgress)
; printerHandle : HANDLE -> "sptr"
; jobId : DWORD -> "int"
; jobOperation : EPrintXPSJobOperation -> "int"
; jobProgress : EPrintXPSJobProgress -> "int"
; HRESULT ReportJobProcessingProgress(HANDLE printerHandle, DWORD jobId, EPrintXPSJobOperation jobOperation, EPrintXPSJobProgress jobProgress)
#uselib "winspool.drv"
#cfunc global ReportJobProcessingProgress "ReportJobProcessingProgress" intptr, int, int, int
; res = ReportJobProcessingProgress(printerHandle, jobId, jobOperation, jobProgress)
; printerHandle : HANDLE -> "intptr"
; jobId : DWORD -> "int"
; jobOperation : EPrintXPSJobOperation -> "int"
; jobProgress : EPrintXPSJobProgress -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	winspool_drv = windows.NewLazySystemDLL("winspool.drv")
	procReportJobProcessingProgress = winspool_drv.NewProc("ReportJobProcessingProgress")
)

// printerHandle (HANDLE), jobId (DWORD), jobOperation (EPrintXPSJobOperation), jobProgress (EPrintXPSJobProgress)
r1, _, err := procReportJobProcessingProgress.Call(
	uintptr(printerHandle),
	uintptr(jobId),
	uintptr(jobOperation),
	uintptr(jobProgress),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function ReportJobProcessingProgress(
  printerHandle: THandle;   // HANDLE
  jobId: DWORD;   // DWORD
  jobOperation: Integer;   // EPrintXPSJobOperation
  jobProgress: Integer   // EPrintXPSJobProgress
): Integer; stdcall;
  external 'winspool.drv' name 'ReportJobProcessingProgress';
result := DllCall("winspool.drv\ReportJobProcessingProgress"
    , "Ptr", printerHandle   ; HANDLE
    , "UInt", jobId   ; DWORD
    , "Int", jobOperation   ; EPrintXPSJobOperation
    , "Int", jobProgress   ; EPrintXPSJobProgress
    , "Int")   ; return: HRESULT
●ReportJobProcessingProgress(printerHandle, jobId, jobOperation, jobProgress) = DLL("winspool.drv", "int ReportJobProcessingProgress(void*, dword, int, int)")
# 呼び出し: ReportJobProcessingProgress(printerHandle, jobId, jobOperation, jobProgress)
# printerHandle : HANDLE -> "void*"
# jobId : DWORD -> "dword"
# jobOperation : EPrintXPSJobOperation -> "int"
# jobProgress : EPrintXPSJobProgress -> "int"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef ReportJobProcessingProgressNative = Int32 Function(Pointer<Void>, Uint32, Int32, Int32);
typedef ReportJobProcessingProgressDart = int Function(Pointer<Void>, int, int, int);
final ReportJobProcessingProgress = DynamicLibrary.open('winspool.drv')
    .lookupFunction<ReportJobProcessingProgressNative, ReportJobProcessingProgressDart>('ReportJobProcessingProgress');
// printerHandle : HANDLE -> Pointer<Void>
// jobId : DWORD -> Uint32
// jobOperation : EPrintXPSJobOperation -> Int32
// jobProgress : EPrintXPSJobProgress -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function ReportJobProcessingProgress(
  printerHandle: THandle;   // HANDLE
  jobId: DWORD;   // DWORD
  jobOperation: Integer;   // EPrintXPSJobOperation
  jobProgress: Integer   // EPrintXPSJobProgress
): Integer; stdcall;
  external 'winspool.drv' name 'ReportJobProcessingProgress';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "ReportJobProcessingProgress"
  c_ReportJobProcessingProgress :: Ptr () -> Word32 -> Int32 -> Int32 -> IO Int32
-- printerHandle : HANDLE -> Ptr ()
-- jobId : DWORD -> Word32
-- jobOperation : EPrintXPSJobOperation -> Int32
-- jobProgress : EPrintXPSJobProgress -> Int32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let reportjobprocessingprogress =
  foreign "ReportJobProcessingProgress"
    ((ptr void) @-> uint32_t @-> int32_t @-> int32_t @-> returning int32_t)
(* printerHandle : HANDLE -> (ptr void) *)
(* jobId : DWORD -> uint32_t *)
(* jobOperation : EPrintXPSJobOperation -> int32_t *)
(* jobProgress : EPrintXPSJobProgress -> int32_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 ("ReportJobProcessingProgress" report-job-processing-progress :convention :stdcall) :int32
  (printer-handle :pointer)   ; HANDLE
  (job-id :uint32)   ; DWORD
  (job-operation :int32)   ; EPrintXPSJobOperation
  (job-progress :int32))   ; EPrintXPSJobProgress
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $ReportJobProcessingProgress = Win32::API::More->new('winspool.drv',
    'int ReportJobProcessingProgress(HANDLE printerHandle, DWORD jobId, int jobOperation, int jobProgress)');
# my $ret = $ReportJobProcessingProgress->Call($printerHandle, $jobId, $jobOperation, $jobProgress);
# printerHandle : HANDLE -> HANDLE
# jobId : DWORD -> DWORD
# jobOperation : EPrintXPSJobOperation -> int
# jobProgress : EPrintXPSJobProgress -> int
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型