ホーム › Storage.Xps.Printing › StartXpsPrintJob

StartXpsPrintJob

関数

XPSドキュメントの印刷ジョブを開始する。

DLLXPSPRINT.dll呼出規約winapi対応OSWindows 7 以降

シグネチャ

// XPSPRINT.dll
#include <windows.h>

HRESULT StartXpsPrintJob(
    LPCWSTR printerName,
    LPCWSTR jobName,
    LPCWSTR outputFileName,
    HANDLE progressEvent,
    HANDLE completionEvent,
    BYTE* printablePagesOn,
    DWORD printablePagesOnCount,
    IXpsPrintJob** xpsPrintJob,
    IXpsPrintJobStream** documentStream,
    IXpsPrintJobStream** printTicketStream
);

パラメーター

名前	型	方向
printerName	LPCWSTR	in
jobName	LPCWSTR	in
outputFileName	LPCWSTR	in
progressEvent	HANDLE	in
completionEvent	HANDLE	in
printablePagesOn	BYTE*	in
printablePagesOnCount	DWORD	in
xpsPrintJob	IXpsPrintJob**	out
documentStream	IXpsPrintJobStream**	out
printTicketStream	IXpsPrintJobStream**	out

戻り値の型: HRESULT

各言語での呼び出し定義

// XPSPRINT.dll
#include <windows.h>

HRESULT StartXpsPrintJob(
    LPCWSTR printerName,
    LPCWSTR jobName,
    LPCWSTR outputFileName,
    HANDLE progressEvent,
    HANDLE completionEvent,
    BYTE* printablePagesOn,
    DWORD printablePagesOnCount,
    IXpsPrintJob** xpsPrintJob,
    IXpsPrintJobStream** documentStream,
    IXpsPrintJobStream** printTicketStream
);

[DllImport("XPSPRINT.dll", ExactSpelling = true)]
static extern int StartXpsPrintJob(
    [MarshalAs(UnmanagedType.LPWStr)] string printerName,   // LPCWSTR
    [MarshalAs(UnmanagedType.LPWStr)] string jobName,   // LPCWSTR
    [MarshalAs(UnmanagedType.LPWStr)] string outputFileName,   // LPCWSTR
    IntPtr progressEvent,   // HANDLE
    IntPtr completionEvent,   // HANDLE
    IntPtr printablePagesOn,   // BYTE*
    uint printablePagesOnCount,   // DWORD
    IntPtr xpsPrintJob,   // IXpsPrintJob** out
    IntPtr documentStream,   // IXpsPrintJobStream** out
    IntPtr printTicketStream   // IXpsPrintJobStream** out
);

<DllImport("XPSPRINT.dll", ExactSpelling:=True)>
Public Shared Function StartXpsPrintJob(
    <MarshalAs(UnmanagedType.LPWStr)> printerName As String,   ' LPCWSTR
    <MarshalAs(UnmanagedType.LPWStr)> jobName As String,   ' LPCWSTR
    <MarshalAs(UnmanagedType.LPWStr)> outputFileName As String,   ' LPCWSTR
    progressEvent As IntPtr,   ' HANDLE
    completionEvent As IntPtr,   ' HANDLE
    printablePagesOn As IntPtr,   ' BYTE*
    printablePagesOnCount As UInteger,   ' DWORD
    xpsPrintJob As IntPtr,   ' IXpsPrintJob** out
    documentStream As IntPtr,   ' IXpsPrintJobStream** out
    printTicketStream As IntPtr   ' IXpsPrintJobStream** out
) As Integer
End Function

' printerName : LPCWSTR
' jobName : LPCWSTR
' outputFileName : LPCWSTR
' progressEvent : HANDLE
' completionEvent : HANDLE
' printablePagesOn : BYTE*
' printablePagesOnCount : DWORD
' xpsPrintJob : IXpsPrintJob** out
' documentStream : IXpsPrintJobStream** out
' printTicketStream : IXpsPrintJobStream** out
Declare PtrSafe Function StartXpsPrintJob Lib "xpsprint" ( _
    ByVal printerName As LongPtr, _
    ByVal jobName As LongPtr, _
    ByVal outputFileName As LongPtr, _
    ByVal progressEvent As LongPtr, _
    ByVal completionEvent As LongPtr, _
    ByVal printablePagesOn As LongPtr, _
    ByVal printablePagesOnCount As Long, _
    ByVal xpsPrintJob As LongPtr, _
    ByVal documentStream As LongPtr, _
    ByVal printTicketStream As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

StartXpsPrintJob = ctypes.windll.xpsprint.StartXpsPrintJob
StartXpsPrintJob.restype = ctypes.c_int
StartXpsPrintJob.argtypes = [
    wintypes.LPCWSTR,  # printerName : LPCWSTR
    wintypes.LPCWSTR,  # jobName : LPCWSTR
    wintypes.LPCWSTR,  # outputFileName : LPCWSTR
    wintypes.HANDLE,  # progressEvent : HANDLE
    wintypes.HANDLE,  # completionEvent : HANDLE
    ctypes.POINTER(ctypes.c_ubyte),  # printablePagesOn : BYTE*
    wintypes.DWORD,  # printablePagesOnCount : DWORD
    ctypes.c_void_p,  # xpsPrintJob : IXpsPrintJob** out
    ctypes.c_void_p,  # documentStream : IXpsPrintJobStream** out
    ctypes.c_void_p,  # printTicketStream : IXpsPrintJobStream** out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('XPSPRINT.dll')
StartXpsPrintJob = Fiddle::Function.new(
  lib['StartXpsPrintJob'],
  [
    Fiddle::TYPE_VOIDP,  # printerName : LPCWSTR
    Fiddle::TYPE_VOIDP,  # jobName : LPCWSTR
    Fiddle::TYPE_VOIDP,  # outputFileName : LPCWSTR
    Fiddle::TYPE_VOIDP,  # progressEvent : HANDLE
    Fiddle::TYPE_VOIDP,  # completionEvent : HANDLE
    Fiddle::TYPE_VOIDP,  # printablePagesOn : BYTE*
    -Fiddle::TYPE_INT,  # printablePagesOnCount : DWORD
    Fiddle::TYPE_VOIDP,  # xpsPrintJob : IXpsPrintJob** out
    Fiddle::TYPE_VOIDP,  # documentStream : IXpsPrintJobStream** out
    Fiddle::TYPE_VOIDP,  # printTicketStream : IXpsPrintJobStream** out
  ],
  Fiddle::TYPE_INT)

#[link(name = "xpsprint")]
extern "system" {
    fn StartXpsPrintJob(
        printerName: *const u16,  // LPCWSTR
        jobName: *const u16,  // LPCWSTR
        outputFileName: *const u16,  // LPCWSTR
        progressEvent: *mut core::ffi::c_void,  // HANDLE
        completionEvent: *mut core::ffi::c_void,  // HANDLE
        printablePagesOn: *mut u8,  // BYTE*
        printablePagesOnCount: u32,  // DWORD
        xpsPrintJob: *mut *mut core::ffi::c_void,  // IXpsPrintJob** out
        documentStream: *mut *mut core::ffi::c_void,  // IXpsPrintJobStream** out
        printTicketStream: *mut *mut core::ffi::c_void  // IXpsPrintJobStream** out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("XPSPRINT.dll")]
public static extern int StartXpsPrintJob([MarshalAs(UnmanagedType.LPWStr)] string printerName, [MarshalAs(UnmanagedType.LPWStr)] string jobName, [MarshalAs(UnmanagedType.LPWStr)] string outputFileName, IntPtr progressEvent, IntPtr completionEvent, IntPtr printablePagesOn, uint printablePagesOnCount, IntPtr xpsPrintJob, IntPtr documentStream, IntPtr printTicketStream);
"@
$api = Add-Type -MemberDefinition $sig -Name 'XPSPRINT_StartXpsPrintJob' -Namespace Win32 -PassThru
# $api::StartXpsPrintJob(printerName, jobName, outputFileName, progressEvent, completionEvent, printablePagesOn, printablePagesOnCount, xpsPrintJob, documentStream, printTicketStream)

#uselib "XPSPRINT.dll"
#func global StartXpsPrintJob "StartXpsPrintJob" sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr
; StartXpsPrintJob printerName, jobName, outputFileName, progressEvent, completionEvent, varptr(printablePagesOn), printablePagesOnCount, xpsPrintJob, documentStream, printTicketStream   ; 戻り値は stat
; printerName : LPCWSTR -> "sptr"
; jobName : LPCWSTR -> "sptr"
; outputFileName : LPCWSTR -> "sptr"
; progressEvent : HANDLE -> "sptr"
; completionEvent : HANDLE -> "sptr"
; printablePagesOn : BYTE* -> "sptr"
; printablePagesOnCount : DWORD -> "sptr"
; xpsPrintJob : IXpsPrintJob** out -> "sptr"
; documentStream : IXpsPrintJobStream** out -> "sptr"
; printTicketStream : IXpsPrintJobStream** out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "XPSPRINT.dll"
#cfunc global StartXpsPrintJob "StartXpsPrintJob" wstr, wstr, wstr, sptr, sptr, var, int, sptr, sptr, sptr
; res = StartXpsPrintJob(printerName, jobName, outputFileName, progressEvent, completionEvent, printablePagesOn, printablePagesOnCount, xpsPrintJob, documentStream, printTicketStream)
; printerName : LPCWSTR -> "wstr"
; jobName : LPCWSTR -> "wstr"
; outputFileName : LPCWSTR -> "wstr"
; progressEvent : HANDLE -> "sptr"
; completionEvent : HANDLE -> "sptr"
; printablePagesOn : BYTE* -> "var"
; printablePagesOnCount : DWORD -> "int"
; xpsPrintJob : IXpsPrintJob** out -> "sptr"
; documentStream : IXpsPrintJobStream** out -> "sptr"
; printTicketStream : IXpsPrintJobStream** out -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "XPSPRINT.dll"
#cfunc global StartXpsPrintJob "StartXpsPrintJob" wstr, wstr, wstr, sptr, sptr, sptr, int, sptr, sptr, sptr
; res = StartXpsPrintJob(printerName, jobName, outputFileName, progressEvent, completionEvent, varptr(printablePagesOn), printablePagesOnCount, xpsPrintJob, documentStream, printTicketStream)
; printerName : LPCWSTR -> "wstr"
; jobName : LPCWSTR -> "wstr"
; outputFileName : LPCWSTR -> "wstr"
; progressEvent : HANDLE -> "sptr"
; completionEvent : HANDLE -> "sptr"
; printablePagesOn : BYTE* -> "sptr"
; printablePagesOnCount : DWORD -> "int"
; xpsPrintJob : IXpsPrintJob** out -> "sptr"
; documentStream : IXpsPrintJobStream** out -> "sptr"
; printTicketStream : IXpsPrintJobStream** out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。

出力引数:

; HRESULT StartXpsPrintJob(LPCWSTR printerName, LPCWSTR jobName, LPCWSTR outputFileName, HANDLE progressEvent, HANDLE completionEvent, BYTE* printablePagesOn, DWORD printablePagesOnCount, IXpsPrintJob** xpsPrintJob, IXpsPrintJobStream** documentStream, IXpsPrintJobStream** printTicketStream)
#uselib "XPSPRINT.dll"
#cfunc global StartXpsPrintJob "StartXpsPrintJob" wstr, wstr, wstr, intptr, intptr, var, int, intptr, intptr, intptr
; res = StartXpsPrintJob(printerName, jobName, outputFileName, progressEvent, completionEvent, printablePagesOn, printablePagesOnCount, xpsPrintJob, documentStream, printTicketStream)
; printerName : LPCWSTR -> "wstr"
; jobName : LPCWSTR -> "wstr"
; outputFileName : LPCWSTR -> "wstr"
; progressEvent : HANDLE -> "intptr"
; completionEvent : HANDLE -> "intptr"
; printablePagesOn : BYTE* -> "var"
; printablePagesOnCount : DWORD -> "int"
; xpsPrintJob : IXpsPrintJob** out -> "intptr"
; documentStream : IXpsPrintJobStream** out -> "intptr"
; printTicketStream : IXpsPrintJobStream** out -> "intptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; HRESULT StartXpsPrintJob(LPCWSTR printerName, LPCWSTR jobName, LPCWSTR outputFileName, HANDLE progressEvent, HANDLE completionEvent, BYTE* printablePagesOn, DWORD printablePagesOnCount, IXpsPrintJob** xpsPrintJob, IXpsPrintJobStream** documentStream, IXpsPrintJobStream** printTicketStream)
#uselib "XPSPRINT.dll"
#cfunc global StartXpsPrintJob "StartXpsPrintJob" wstr, wstr, wstr, intptr, intptr, intptr, int, intptr, intptr, intptr
; res = StartXpsPrintJob(printerName, jobName, outputFileName, progressEvent, completionEvent, varptr(printablePagesOn), printablePagesOnCount, xpsPrintJob, documentStream, printTicketStream)
; printerName : LPCWSTR -> "wstr"
; jobName : LPCWSTR -> "wstr"
; outputFileName : LPCWSTR -> "wstr"
; progressEvent : HANDLE -> "intptr"
; completionEvent : HANDLE -> "intptr"
; printablePagesOn : BYTE* -> "intptr"
; printablePagesOnCount : DWORD -> "int"
; xpsPrintJob : IXpsPrintJob** out -> "intptr"
; documentStream : IXpsPrintJobStream** out -> "intptr"
; printTicketStream : IXpsPrintJobStream** out -> "intptr"
; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。

import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	xpsprint = windows.NewLazySystemDLL("XPSPRINT.dll")
	procStartXpsPrintJob = xpsprint.NewProc("StartXpsPrintJob")
)

// printerName (LPCWSTR), jobName (LPCWSTR), outputFileName (LPCWSTR), progressEvent (HANDLE), completionEvent (HANDLE), printablePagesOn (BYTE*), printablePagesOnCount (DWORD), xpsPrintJob (IXpsPrintJob** out), documentStream (IXpsPrintJobStream** out), printTicketStream (IXpsPrintJobStream** out)
r1, _, err := procStartXpsPrintJob.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(printerName))),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(jobName))),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(outputFileName))),
	uintptr(progressEvent),
	uintptr(completionEvent),
	uintptr(printablePagesOn),
	uintptr(printablePagesOnCount),
	uintptr(xpsPrintJob),
	uintptr(documentStream),
	uintptr(printTicketStream),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT

function StartXpsPrintJob(
  printerName: PWideChar;   // LPCWSTR
  jobName: PWideChar;   // LPCWSTR
  outputFileName: PWideChar;   // LPCWSTR
  progressEvent: THandle;   // HANDLE
  completionEvent: THandle;   // HANDLE
  printablePagesOn: Pointer;   // BYTE*
  printablePagesOnCount: DWORD;   // DWORD
  xpsPrintJob: Pointer;   // IXpsPrintJob** out
  documentStream: Pointer;   // IXpsPrintJobStream** out
  printTicketStream: Pointer   // IXpsPrintJobStream** out
): Integer; stdcall;
  external 'XPSPRINT.dll' name 'StartXpsPrintJob';

result := DllCall("XPSPRINT\StartXpsPrintJob"
    , "WStr", printerName   ; LPCWSTR
    , "WStr", jobName   ; LPCWSTR
    , "WStr", outputFileName   ; LPCWSTR
    , "Ptr", progressEvent   ; HANDLE
    , "Ptr", completionEvent   ; HANDLE
    , "Ptr", printablePagesOn   ; BYTE*
    , "UInt", printablePagesOnCount   ; DWORD
    , "Ptr", xpsPrintJob   ; IXpsPrintJob** out
    , "Ptr", documentStream   ; IXpsPrintJobStream** out
    , "Ptr", printTicketStream   ; IXpsPrintJobStream** out
    , "Int")   ; return: HRESULT

●StartXpsPrintJob(printerName, jobName, outputFileName, progressEvent, completionEvent, printablePagesOn, printablePagesOnCount, xpsPrintJob, documentStream, printTicketStream) = DLL("XPSPRINT.dll", "int StartXpsPrintJob(char*, char*, char*, void*, void*, void*, dword, void*, void*, void*)")
# 呼び出し: StartXpsPrintJob(printerName, jobName, outputFileName, progressEvent, completionEvent, printablePagesOn, printablePagesOnCount, xpsPrintJob, documentStream, printTicketStream)
# printerName : LPCWSTR -> "char*"
# jobName : LPCWSTR -> "char*"
# outputFileName : LPCWSTR -> "char*"
# progressEvent : HANDLE -> "void*"
# completionEvent : HANDLE -> "void*"
# printablePagesOn : BYTE* -> "void*"
# printablePagesOnCount : DWORD -> "dword"
# xpsPrintJob : IXpsPrintJob** out -> "void*"
# documentStream : IXpsPrintJobStream** out -> "void*"
# printTicketStream : IXpsPrintJobStream** out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。