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

SetJobW

関数
印刷ジョブの設定変更や一時停止・削除を行う(Unicode版)。
DLLwinspool.drv文字セットUnicode (-W)呼出規約winapi

シグネチャ

// winspool.drv  (Unicode / -W)
#include <windows.h>

BOOL SetJobW(
    PRINTER_HANDLE hPrinter,
    DWORD JobId,
    DWORD Level,
    BYTE* pJob,   // optional
    DWORD Command
);

パラメーター

名前方向説明
hPrinterPRINTER_HANDLEinOpenPrinterで取得したプリンタのハンドル。
JobIdDWORDin操作対象の印刷ジョブの識別子。
LevelDWORDinpJobが指すJOB_INFO構造体のレベル(0,1,2,3,4)。
pJobBYTE*inoptional更新内容を含むJOB_INFO構造体(Unicode)へのポインタ。
CommandDWORDinジョブ操作コマンド。JOB_CONTROL_PAUSEなど。

戻り値の型: BOOL

各言語での呼び出し定義

// winspool.drv  (Unicode / -W)
#include <windows.h>

BOOL SetJobW(
    PRINTER_HANDLE hPrinter,
    DWORD JobId,
    DWORD Level,
    BYTE* pJob,   // optional
    DWORD Command
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("winspool.drv", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern bool SetJobW(
    PRINTER_HANDLE hPrinter,   // PRINTER_HANDLE
    uint JobId,   // DWORD
    uint Level,   // DWORD
    IntPtr pJob,   // BYTE* optional
    uint Command   // DWORD
);
<DllImport("winspool.drv", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function SetJobW(
    hPrinter As PRINTER_HANDLE,   ' PRINTER_HANDLE
    JobId As UInteger,   ' DWORD
    Level As UInteger,   ' DWORD
    pJob As IntPtr,   ' BYTE* optional
    Command As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' hPrinter : PRINTER_HANDLE
' JobId : DWORD
' Level : DWORD
' pJob : BYTE* optional
' Command : DWORD
Declare PtrSafe Function SetJobW Lib "winspool.drv" ( _
    ByVal hPrinter As LongPtr, _
    ByVal JobId As Long, _
    ByVal Level As Long, _
    ByVal pJob As LongPtr, _
    ByVal Command As Long) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SetJobW = ctypes.windll.LoadLibrary("winspool.drv").SetJobW
SetJobW.restype = wintypes.BOOL
SetJobW.argtypes = [
    PRINTER_HANDLE,  # hPrinter : PRINTER_HANDLE
    wintypes.DWORD,  # JobId : DWORD
    wintypes.DWORD,  # Level : DWORD
    ctypes.POINTER(ctypes.c_ubyte),  # pJob : BYTE* optional
    wintypes.DWORD,  # Command : DWORD
]
require 'fiddle'
require 'fiddle/import'

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

var (
	winspool_drv = windows.NewLazySystemDLL("winspool.drv")
	procSetJobW = winspool_drv.NewProc("SetJobW")
)

// hPrinter (PRINTER_HANDLE), JobId (DWORD), Level (DWORD), pJob (BYTE* optional), Command (DWORD)
r1, _, err := procSetJobW.Call(
	uintptr(hPrinter),
	uintptr(JobId),
	uintptr(Level),
	uintptr(pJob),
	uintptr(Command),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function SetJobW(
  hPrinter: PRINTER_HANDLE;   // PRINTER_HANDLE
  JobId: DWORD;   // DWORD
  Level: DWORD;   // DWORD
  pJob: Pointer;   // BYTE* optional
  Command: DWORD   // DWORD
): BOOL; stdcall;
  external 'winspool.drv' name 'SetJobW';
result := DllCall("winspool.drv\SetJobW"
    , "Ptr", hPrinter   ; PRINTER_HANDLE
    , "UInt", JobId   ; DWORD
    , "UInt", Level   ; DWORD
    , "Ptr", pJob   ; BYTE* optional
    , "UInt", Command   ; DWORD
    , "Int")   ; return: BOOL
●SetJobW(hPrinter, JobId, Level, pJob, Command) = DLL("winspool.drv", "bool SetJobW(void*, dword, dword, void*, dword)")
# 呼び出し: SetJobW(hPrinter, JobId, Level, pJob, Command)
# hPrinter : PRINTER_HANDLE -> "void*"
# JobId : DWORD -> "dword"
# Level : DWORD -> "dword"
# pJob : BYTE* optional -> "void*"
# Command : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "winspool.drv" fn SetJobW(
    hPrinter: PRINTER_HANDLE, // PRINTER_HANDLE
    JobId: u32, // DWORD
    Level: u32, // DWORD
    pJob: [*c]u8, // BYTE* optional
    Command: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc SetJobW(
    hPrinter: PRINTER_HANDLE,  # PRINTER_HANDLE
    JobId: uint32,  # DWORD
    Level: uint32,  # DWORD
    pJob: ptr uint8,  # BYTE* optional
    Command: uint32  # DWORD
): int32 {.importc: "SetJobW", stdcall, dynlib: "winspool.drv".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "winspool.drv");
extern(Windows)
int SetJobW(
    PRINTER_HANDLE hPrinter,   // PRINTER_HANDLE
    uint JobId,   // DWORD
    uint Level,   // DWORD
    ubyte* pJob,   // BYTE* optional
    uint Command   // DWORD
);
ccall((:SetJobW, "winspool.drv"), stdcall, Int32,
      (PRINTER_HANDLE, UInt32, UInt32, Ptr{UInt8}, UInt32),
      hPrinter, JobId, Level, pJob, Command)
# hPrinter : PRINTER_HANDLE -> PRINTER_HANDLE
# JobId : DWORD -> UInt32
# Level : DWORD -> UInt32
# pJob : BYTE* optional -> Ptr{UInt8}
# Command : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t SetJobW(
    PRINTER_HANDLE hPrinter,
    uint32_t JobId,
    uint32_t Level,
    uint8_t* pJob,
    uint32_t Command);
]]
local winspool.drv = ffi.load("winspool.drv")
-- winspool.drv.SetJobW(hPrinter, JobId, Level, pJob, Command)
-- hPrinter : PRINTER_HANDLE
-- JobId : DWORD
-- Level : DWORD
-- pJob : BYTE* optional
-- Command : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('winspool.drv');
const SetJobW = lib.func('__stdcall', 'SetJobW', 'int32_t', ['PRINTER_HANDLE', 'uint32_t', 'uint32_t', 'uint8_t *', 'uint32_t']);
// SetJobW(hPrinter, JobId, Level, pJob, Command)
// hPrinter : PRINTER_HANDLE -> 'PRINTER_HANDLE'
// JobId : DWORD -> 'uint32_t'
// Level : DWORD -> 'uint32_t'
// pJob : BYTE* optional -> 'uint8_t *'
// Command : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("winspool.drv", {
  SetJobW: { parameters: ["buffer", "u32", "u32", "pointer", "u32"], result: "i32" },
});
// lib.symbols.SetJobW(hPrinter, JobId, Level, pJob, Command)
// hPrinter : PRINTER_HANDLE -> "buffer"
// JobId : DWORD -> "u32"
// Level : DWORD -> "u32"
// pJob : BYTE* optional -> "pointer"
// Command : DWORD -> "u32"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SetJobW(
    PRINTER_HANDLE hPrinter,
    uint32_t JobId,
    uint32_t Level,
    uint8_t* pJob,
    uint32_t Command);
C, "winspool.drv");
// $ffi->SetJobW(hPrinter, JobId, Level, pJob, Command);
// hPrinter : PRINTER_HANDLE
// JobId : DWORD
// Level : DWORD
// pJob : BYTE* optional
// Command : 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, W32APIOptions.UNICODE_OPTIONS);
    boolean SetJobW(
        PRINTER_HANDLE /* extends Structure (by value) */ hPrinter,   // PRINTER_HANDLE
        int JobId,   // DWORD
        int Level,   // DWORD
        byte[] pJob,   // BYTE* optional
        int Command   // DWORD
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("winspool.drv")]
lib Libwinspool.drv
  fun SetJobW = SetJobW(
    hPrinter : PRINTER_HANDLE,   # PRINTER_HANDLE
    JobId : UInt32,   # DWORD
    Level : UInt32,   # DWORD
    pJob : UInt8*,   # BYTE* optional
    Command : 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 SetJobWNative = Int32 Function(PRINTER_HANDLE, Uint32, Uint32, Pointer<Uint8>, Uint32);
typedef SetJobWDart = int Function(int, int, int, Pointer<Uint8>, int);
final SetJobW = DynamicLibrary.open('winspool.drv')
    .lookupFunction<SetJobWNative, SetJobWDart>('SetJobW');
// hPrinter : PRINTER_HANDLE -> PRINTER_HANDLE
// JobId : DWORD -> Uint32
// Level : DWORD -> Uint32
// pJob : BYTE* optional -> Pointer<Uint8>
// Command : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SetJobW(
  hPrinter: PRINTER_HANDLE;   // PRINTER_HANDLE
  JobId: DWORD;   // DWORD
  Level: DWORD;   // DWORD
  pJob: Pointer;   // BYTE* optional
  Command: DWORD   // DWORD
): BOOL; stdcall;
  external 'winspool.drv' name 'SetJobW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let setjobw =
  foreign "SetJobW"
    (PRINTER_HANDLE @-> uint32_t @-> uint32_t @-> (ptr uint8_t) @-> uint32_t @-> returning int32_t)
(* hPrinter : PRINTER_HANDLE -> PRINTER_HANDLE *)
(* JobId : DWORD -> uint32_t *)
(* Level : DWORD -> uint32_t *)
(* pJob : BYTE* optional -> (ptr uint8_t) *)
(* Command : 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 ("SetJobW" set-job-w :convention :stdcall) :int32
  (h-printer (:struct printer-handle))   ; PRINTER_HANDLE
  (job-id :uint32)   ; DWORD
  (level :uint32)   ; DWORD
  (p-job :pointer)   ; BYTE* optional
  (command :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SetJobW = Win32::API::More->new('winspool.drv',
    'BOOL SetJobW(LPVOID hPrinter, DWORD JobId, DWORD Level, LPVOID pJob, DWORD Command)');
# my $ret = $SetJobW->Call($hPrinter, $JobId, $Level, $pJob, $Command);
# hPrinter : PRINTER_HANDLE -> LPVOID
# JobId : DWORD -> DWORD
# Level : DWORD -> DWORD
# pJob : BYTE* optional -> LPVOID
# Command : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い
使用する型