Win32 API 日本語リファレンス
ホーム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
);

パラメーター

名前方向説明
printerNameLPCWSTRinこのジョブに関連付けられるプリンターの名前。
jobNameLPCWSTRinこのジョブに関連付ける、ユーザーが指定するジョブ名。ジョブに個別のユーザー指定名が不要な場合、このパラメーターには NULL を設定できます。
outputFileNameLPCWSTRinこのジョブの出力のリダイレクト先となるファイルまたはポートのファイル名。この値を設定すると、印刷ジョブの出力は指定されたファイルまたはポートに送られます。printerName で指定したプリンターに印刷ジョブを送るには、このパラメーターに NULL を設定する必要があります。
progressEventHANDLEin

次の印刷ジョブの変化が発生したときにシグナル状態になるイベントハンドル。

  • 印刷ジョブにジョブ ID が割り当てられた
  • ページの印刷が完了した
  • ドキュメントの印刷が完了した
  • 印刷ジョブが取り消された、またはエラーにより終了した
注意 このイベントは、アプリケーションが印刷ジョブへのデータ送信を開始するまではシグナル状態になりません。

XPS Print API はこのイベントをリセットしません。リセットは呼び出し側の責任です。

進行状況の通知が不要な場合、このパラメーターには NULL を設定できます。

completionEventHANDLEin

印刷ジョブが終了したときにシグナル状態になるイベントハンドル。このイベントは、StartXpsPrintJob の呼び出しごとに必ず 1 回だけシグナル状態になることが保証されています。XPS Print API はこのイベントをリセットしません。リセットは呼び出し側の責任です。

完了通知が不要な場合、このパラメーターには NULL を設定できます。

printablePagesOnBYTE*in

このパラメーターは、ドキュメント内の印刷対象とするページの部分集合を各要素で指定する UINT8 配列を参照します。次の表に示すように、各要素の値はそのページを印刷するかどうかを示します。

配列要素の値 意味
0
そのページを印刷しません。
0 以外
そのページを印刷します。

進行状況イベントは、印刷対象として指定されたページについてのみシグナル状態になります。

配列の各要素は、XPS パッケージ内のすべてのドキュメントについて、印刷対象として指定できるすべてのページを表します。たとえば、パッケージに 3 ページずつのドキュメントが 2 つ含まれている場合、次の表に示す配列は、ドキュメント 1 のページ 0 と 2、およびドキュメント 2 のページ 0 と 2 を印刷するよう指定します。

要素のインデックス 要素の値 印刷するか ドキュメント番号 ページ番号
5 1 する 2 2
4 0 しない 2 1
3 1 する 2 0
2 1 する 1 2
1 0 しない 1 1
0 1 する 1 0

printablePagesOnNULL の場合、パッケージ内のすべてのページが印刷されます。

printablePagesOn の要素数がパッケージ内のページ数より多い場合、余分な要素は無視されます。

配列の要素数がドキュメント内のページ数より少ない場合、配列の最後の要素の値が残りのページに適用されます。この規則により、終端を定めない範囲や、大きなドキュメントのうち数ページだけを印刷する範囲を簡単に指定できます。

printablePagesOnCountDWORDinprintablePagesOn が参照する配列の要素数。printablePagesOnNULL の場合、このパラメーターは無視されます。
xpsPrintJobIXpsPrintJob**outStartXpsPrintJob によって作成される印刷ジョブを表す IXpsPrintJob インターフェイスへのポインター。印刷ジョブの状態を取得したり、ジョブを取り消したりするには、IXpsPrintJob インターフェイスを使用します。IXpsPrintJob が不要な場合、このパラメーターには NULL を設定できます。
documentStreamIXpsPrintJobStream**outこの印刷ジョブで印刷する XPS ドキュメントを呼び出し側が書き込む IXpsPrintJobStream インターフェイスへのポインター。
printTicketStreamIXpsPrintJobStream**outこのジョブに関連付けられるジョブレベルの印刷チケットを書き込むために呼び出し側が使用する IXpsPrintJobStream インターフェイスへのポインター。このパラメーターに NULL を設定した場合は、documentStream に書き込まれた XPS ドキュメント内の印刷チケット (存在する場合) が使用されます。

戻り値の型: HRESULT

公式ドキュメント

XPS ドキュメントストリームのプリンターへの印刷を開始します。

戻り値

このメソッドは HRESULT を返します。指定できる値には次の表の値が含まれますが、これらに限定されません。

戻り値 説明
S_OK
メソッドは成功しました。
E_POINTER
printerName または documentStreamNULL です。
E_OUTOFMEMORY
新しい IXpsPrintJob オブジェクトを作成するためのメモリが不足しています。

解説(Remarks)

StartXpsPrintJob は非同期関数であり、印刷スプーラーが印刷ジョブを作成または開始する前に戻ることがあります。

xpsPrintJobdocumentStreamprintTicketStream で返されるインターフェイスは、StartXpsPrintJob が正常に戻るまで使用してはなりません。

呼び出し側は、データの送信を開始した後、progressEvent に渡したイベントにシグナル通知される進行状況イベントを監視する必要があります。イベントがシグナル状態になったら、呼び出し側は IXpsPrintJob::GetJobStatus を呼び出して印刷ジョブの現在の状態を取得しなければなりません。

印刷ジョブが終了すると、成功したかどうかにかかわらず、completionEvent に渡したイベントが 1 回だけシグナル状態になります。データの損失を防ぐため、呼び出し側はこのイベントを監視し、このイベントがシグナル状態になるまで呼び出し側のスレッドやアプリケーションを終了させないでください。

ジョブの状態は、印刷スプーラーによって保存もキューイングもされません。ジョブの処理はイベントのシグナル通知後に状態が読み取られるのを待たないため、アプリケーションが変更通知を受け取ってから IXpsPrintJob::GetJobStatus を呼び出すまでの遅延によっては、呼び出し側が一部の状態変化を取りこぼす可能性があります。以降の通知を受け取るには、アプリケーションは通知を受け取った後で進行状況イベントをリセットする必要があります。

StartXpsPrintJob の呼び出しが失敗した場合は、ジョブの状態が更新され、完了イベントと進行状況イベントがシグナル状態になり、エラーコードが返されます。失敗した印刷ジョブの状態を取得するには、IXpsPrintJob::GetJobStatus を呼び出します。

StartXpsPrintJob は、completionEventprogressEvent がジョブの存続期間中有効であり続けるようにするため、これらに対して DuplicateHandle を呼び出します。印刷スプーラーはこれらのイベントの複製ハンドルを使用するため、呼び出し側はジョブの実行に影響を与えることなく、任意の時点でこれらのハンドルを閉じることができます。ただし、推奨される手順は、completionEvent イベントがシグナル状態になり、呼び出し側がそれを確認した後にのみ、これらのハンドルを閉じることです。

documentStreamprintTicketStream で返される IXpsPrintJobStream インターフェイスは書き込み専用のストリームであり、シークはできませんが閉じることはできます。呼び出し側はこれらのストリームに XPS ドキュメントと印刷チケットの内容を書き込み、すべてのデータを書き込んだ後に Close を呼び出します。ストリームの Write メソッドの呼び出しはスレッドセーフですが、異なるスレッドから呼び出した場合、期待した順序でストリームに反映されることは保証されません。

注意 ファイルに印刷する場合、印刷先ファイルへの出力操作のために outputFileName パラメーターに渡す値を用意するのはアプリケーションの責任です。FILE: ポートに出力するドライバーを使用するプリンターに印刷するには、呼び出し側がコモンファイルダイアログを表示してユーザーからファイル名を取得する必要があります。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// 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 方式にも切替可。
出力引数:
; 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 方式にも切替可。
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)。
const std = @import("std");

extern "xpsprint" fn StartXpsPrintJob(
    printerName: [*c]const u16, // LPCWSTR
    jobName: [*c]const u16, // LPCWSTR
    outputFileName: [*c]const u16, // LPCWSTR
    progressEvent: ?*anyopaque, // HANDLE
    completionEvent: ?*anyopaque, // HANDLE
    printablePagesOn: [*c]u8, // BYTE*
    printablePagesOnCount: u32, // DWORD
    xpsPrintJob: ?*anyopaque, // IXpsPrintJob** out
    documentStream: ?*anyopaque, // IXpsPrintJobStream** out
    printTicketStream: ?*anyopaque // IXpsPrintJobStream** out
) callconv(std.os.windows.WINAPI) i32;
proc StartXpsPrintJob(
    printerName: WideCString,  # LPCWSTR
    jobName: WideCString,  # LPCWSTR
    outputFileName: WideCString,  # LPCWSTR
    progressEvent: pointer,  # HANDLE
    completionEvent: pointer,  # HANDLE
    printablePagesOn: ptr uint8,  # BYTE*
    printablePagesOnCount: uint32,  # DWORD
    xpsPrintJob: pointer,  # IXpsPrintJob** out
    documentStream: pointer,  # IXpsPrintJobStream** out
    printTicketStream: pointer  # IXpsPrintJobStream** out
): int32 {.importc: "StartXpsPrintJob", stdcall, dynlib: "XPSPRINT.dll".}
pragma(lib, "xpsprint");
extern(Windows)
int StartXpsPrintJob(
    const(wchar)* printerName,   // LPCWSTR
    const(wchar)* jobName,   // LPCWSTR
    const(wchar)* outputFileName,   // LPCWSTR
    void* progressEvent,   // HANDLE
    void* completionEvent,   // HANDLE
    ubyte* printablePagesOn,   // BYTE*
    uint printablePagesOnCount,   // DWORD
    void* xpsPrintJob,   // IXpsPrintJob** out
    void* documentStream,   // IXpsPrintJobStream** out
    void* printTicketStream   // IXpsPrintJobStream** out
);
ccall((:StartXpsPrintJob, "XPSPRINT.dll"), stdcall, Int32,
      (Cwstring, Cwstring, Cwstring, Ptr{Cvoid}, Ptr{Cvoid}, Ptr{UInt8}, UInt32, Ptr{Cvoid}, Ptr{Cvoid}, Ptr{Cvoid}),
      printerName, jobName, outputFileName, progressEvent, completionEvent, printablePagesOn, printablePagesOnCount, xpsPrintJob, documentStream, printTicketStream)
# printerName : LPCWSTR -> Cwstring
# jobName : LPCWSTR -> Cwstring
# outputFileName : LPCWSTR -> Cwstring
# progressEvent : HANDLE -> Ptr{Cvoid}
# completionEvent : HANDLE -> Ptr{Cvoid}
# printablePagesOn : BYTE* -> Ptr{UInt8}
# printablePagesOnCount : DWORD -> UInt32
# xpsPrintJob : IXpsPrintJob** out -> Ptr{Cvoid}
# documentStream : IXpsPrintJobStream** out -> Ptr{Cvoid}
# printTicketStream : IXpsPrintJobStream** out -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t StartXpsPrintJob(
    const uint16_t* printerName,
    const uint16_t* jobName,
    const uint16_t* outputFileName,
    void* progressEvent,
    void* completionEvent,
    uint8_t* printablePagesOn,
    uint32_t printablePagesOnCount,
    void* xpsPrintJob,
    void* documentStream,
    void* printTicketStream);
]]
local xpsprint = ffi.load("xpsprint")
-- xpsprint.StartXpsPrintJob(printerName, jobName, outputFileName, progressEvent, completionEvent, printablePagesOn, printablePagesOnCount, xpsPrintJob, documentStream, printTicketStream)
-- printerName : LPCWSTR
-- jobName : LPCWSTR
-- outputFileName : LPCWSTR
-- progressEvent : HANDLE
-- completionEvent : HANDLE
-- printablePagesOn : BYTE*
-- printablePagesOnCount : DWORD
-- xpsPrintJob : IXpsPrintJob** out
-- documentStream : IXpsPrintJobStream** out
-- printTicketStream : IXpsPrintJobStream** out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('XPSPRINT.dll');
const StartXpsPrintJob = lib.func('__stdcall', 'StartXpsPrintJob', 'int32_t', ['str16', 'str16', 'str16', 'void *', 'void *', 'uint8_t *', 'uint32_t', 'void *', 'void *', 'void *']);
// StartXpsPrintJob(printerName, jobName, outputFileName, progressEvent, completionEvent, printablePagesOn, printablePagesOnCount, xpsPrintJob, documentStream, printTicketStream)
// printerName : LPCWSTR -> 'str16'
// jobName : LPCWSTR -> 'str16'
// outputFileName : LPCWSTR -> 'str16'
// progressEvent : HANDLE -> 'void *'
// completionEvent : HANDLE -> 'void *'
// printablePagesOn : BYTE* -> 'uint8_t *'
// printablePagesOnCount : DWORD -> 'uint32_t'
// xpsPrintJob : IXpsPrintJob** out -> 'void *'
// documentStream : IXpsPrintJobStream** out -> 'void *'
// printTicketStream : IXpsPrintJobStream** out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("XPSPRINT.dll", {
  StartXpsPrintJob: { parameters: ["buffer", "buffer", "buffer", "pointer", "pointer", "pointer", "u32", "pointer", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.StartXpsPrintJob(printerName, jobName, outputFileName, progressEvent, completionEvent, printablePagesOn, printablePagesOnCount, xpsPrintJob, documentStream, printTicketStream)
// printerName : LPCWSTR -> "buffer"
// jobName : LPCWSTR -> "buffer"
// outputFileName : LPCWSTR -> "buffer"
// progressEvent : HANDLE -> "pointer"
// completionEvent : HANDLE -> "pointer"
// printablePagesOn : BYTE* -> "pointer"
// printablePagesOnCount : DWORD -> "u32"
// xpsPrintJob : IXpsPrintJob** out -> "pointer"
// documentStream : IXpsPrintJobStream** out -> "pointer"
// printTicketStream : IXpsPrintJobStream** out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t StartXpsPrintJob(
    const uint16_t* printerName,
    const uint16_t* jobName,
    const uint16_t* outputFileName,
    void* progressEvent,
    void* completionEvent,
    uint8_t* printablePagesOn,
    uint32_t printablePagesOnCount,
    void* xpsPrintJob,
    void* documentStream,
    void* printTicketStream);
C, "XPSPRINT.dll");
// $ffi->StartXpsPrintJob(printerName, jobName, outputFileName, progressEvent, completionEvent, printablePagesOn, printablePagesOnCount, xpsPrintJob, documentStream, printTicketStream);
// printerName : LPCWSTR
// jobName : LPCWSTR
// outputFileName : LPCWSTR
// progressEvent : HANDLE
// completionEvent : HANDLE
// printablePagesOn : BYTE*
// printablePagesOnCount : DWORD
// xpsPrintJob : IXpsPrintJob** out
// documentStream : IXpsPrintJobStream** out
// printTicketStream : IXpsPrintJobStream** out
// 構造体/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 Xpsprint extends StdCallLibrary {
    Xpsprint INSTANCE = Native.load("xpsprint", Xpsprint.class);
    int StartXpsPrintJob(
        WString printerName,   // LPCWSTR
        WString jobName,   // LPCWSTR
        WString outputFileName,   // LPCWSTR
        Pointer progressEvent,   // HANDLE
        Pointer completionEvent,   // HANDLE
        byte[] printablePagesOn,   // BYTE*
        int printablePagesOnCount,   // DWORD
        Pointer xpsPrintJob,   // IXpsPrintJob** out
        Pointer documentStream,   // IXpsPrintJobStream** out
        Pointer printTicketStream   // IXpsPrintJobStream** out
    );
}
@[Link("xpsprint")]
lib LibXPSPRINT
  fun StartXpsPrintJob = StartXpsPrintJob(
    printerName : UInt16*,   # LPCWSTR
    jobName : UInt16*,   # LPCWSTR
    outputFileName : UInt16*,   # LPCWSTR
    progressEvent : Void*,   # HANDLE
    completionEvent : Void*,   # HANDLE
    printablePagesOn : UInt8*,   # BYTE*
    printablePagesOnCount : UInt32,   # DWORD
    xpsPrintJob : Void*,   # IXpsPrintJob** out
    documentStream : Void*,   # IXpsPrintJobStream** out
    printTicketStream : Void*   # IXpsPrintJobStream** out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef StartXpsPrintJobNative = Int32 Function(Pointer<Utf16>, Pointer<Utf16>, Pointer<Utf16>, Pointer<Void>, Pointer<Void>, Pointer<Uint8>, Uint32, Pointer<Void>, Pointer<Void>, Pointer<Void>);
typedef StartXpsPrintJobDart = int Function(Pointer<Utf16>, Pointer<Utf16>, Pointer<Utf16>, Pointer<Void>, Pointer<Void>, Pointer<Uint8>, int, Pointer<Void>, Pointer<Void>, Pointer<Void>);
final StartXpsPrintJob = DynamicLibrary.open('XPSPRINT.dll')
    .lookupFunction<StartXpsPrintJobNative, StartXpsPrintJobDart>('StartXpsPrintJob');
// printerName : LPCWSTR -> Pointer<Utf16>
// jobName : LPCWSTR -> Pointer<Utf16>
// outputFileName : LPCWSTR -> Pointer<Utf16>
// progressEvent : HANDLE -> Pointer<Void>
// completionEvent : HANDLE -> Pointer<Void>
// printablePagesOn : BYTE* -> Pointer<Uint8>
// printablePagesOnCount : DWORD -> Uint32
// xpsPrintJob : IXpsPrintJob** out -> Pointer<Void>
// documentStream : IXpsPrintJobStream** out -> Pointer<Void>
// printTicketStream : IXpsPrintJobStream** out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
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';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "StartXpsPrintJob"
  c_StartXpsPrintJob :: CWString -> CWString -> CWString -> Ptr () -> Ptr () -> Ptr Word8 -> Word32 -> Ptr () -> Ptr () -> Ptr () -> IO Int32
-- printerName : LPCWSTR -> CWString
-- jobName : LPCWSTR -> CWString
-- outputFileName : LPCWSTR -> CWString
-- progressEvent : HANDLE -> Ptr ()
-- completionEvent : HANDLE -> Ptr ()
-- printablePagesOn : BYTE* -> Ptr Word8
-- printablePagesOnCount : DWORD -> Word32
-- xpsPrintJob : IXpsPrintJob** out -> Ptr ()
-- documentStream : IXpsPrintJobStream** out -> Ptr ()
-- printTicketStream : IXpsPrintJobStream** out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let startxpsprintjob =
  foreign "StartXpsPrintJob"
    ((ptr uint16_t) @-> (ptr uint16_t) @-> (ptr uint16_t) @-> (ptr void) @-> (ptr void) @-> (ptr uint8_t) @-> uint32_t @-> (ptr void) @-> (ptr void) @-> (ptr void) @-> returning int32_t)
(* printerName : LPCWSTR -> (ptr uint16_t) *)
(* jobName : LPCWSTR -> (ptr uint16_t) *)
(* outputFileName : LPCWSTR -> (ptr uint16_t) *)
(* progressEvent : HANDLE -> (ptr void) *)
(* completionEvent : HANDLE -> (ptr void) *)
(* printablePagesOn : BYTE* -> (ptr uint8_t) *)
(* printablePagesOnCount : DWORD -> uint32_t *)
(* xpsPrintJob : IXpsPrintJob** out -> (ptr void) *)
(* documentStream : IXpsPrintJobStream** out -> (ptr void) *)
(* printTicketStream : IXpsPrintJobStream** out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library xpsprint (t "XPSPRINT.dll"))
(cffi:use-foreign-library xpsprint)

(cffi:defcfun ("StartXpsPrintJob" start-xps-print-job :convention :stdcall) :int32
  (printer-name (:string :encoding :utf-16le))   ; LPCWSTR
  (job-name (:string :encoding :utf-16le))   ; LPCWSTR
  (output-file-name (:string :encoding :utf-16le))   ; LPCWSTR
  (progress-event :pointer)   ; HANDLE
  (completion-event :pointer)   ; HANDLE
  (printable-pages-on :pointer)   ; BYTE*
  (printable-pages-on-count :uint32)   ; DWORD
  (xps-print-job :pointer)   ; IXpsPrintJob** out
  (document-stream :pointer)   ; IXpsPrintJobStream** out
  (print-ticket-stream :pointer))   ; IXpsPrintJobStream** out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $StartXpsPrintJob = Win32::API::More->new('XPSPRINT',
    'int StartXpsPrintJob(LPCWSTR printerName, LPCWSTR jobName, LPCWSTR outputFileName, HANDLE progressEvent, HANDLE completionEvent, LPVOID printablePagesOn, DWORD printablePagesOnCount, LPVOID xpsPrintJob, LPVOID documentStream, LPVOID printTicketStream)');
# my $ret = $StartXpsPrintJob->Call($printerName, $jobName, $outputFileName, $progressEvent, $completionEvent, $printablePagesOn, $printablePagesOnCount, $xpsPrintJob, $documentStream, $printTicketStream);
# printerName : LPCWSTR -> LPCWSTR
# jobName : LPCWSTR -> LPCWSTR
# outputFileName : LPCWSTR -> LPCWSTR
# progressEvent : HANDLE -> HANDLE
# completionEvent : HANDLE -> HANDLE
# printablePagesOn : BYTE* -> LPVOID
# printablePagesOnCount : DWORD -> DWORD
# xpsPrintJob : IXpsPrintJob** out -> LPVOID
# documentStream : IXpsPrintJobStream** out -> LPVOID
# printTicketStream : IXpsPrintJobStream** out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

類似 API
使用する型