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

SplPromptUIInUsersSession

関数
ユーザーセッション内に印刷UIを表示し応答を得る。
DLLSPOOLSS.dll呼出規約winapi

シグネチャ

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

BOOL SplPromptUIInUsersSession(
    PRINTER_HANDLE hPrinter,
    DWORD JobId,
    SHOWUIPARAMS* pUIParams,
    DWORD* pResponse
);

パラメーター

名前方向説明
hPrinterPRINTER_HANDLEinOpenPrinterで取得したプリンタハンドル。
JobIdDWORDinUI表示の対象となる印刷ジョブの識別子。
pUIParamsSHOWUIPARAMS*in表示するUIの内容を指定するSHOWUIPARAMS構造体へのポインタ。
pResponseDWORD*outユーザーの応答結果を受け取るDWORDへのポインタ。

戻り値の型: BOOL

各言語での呼び出し定義

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

BOOL SplPromptUIInUsersSession(
    PRINTER_HANDLE hPrinter,
    DWORD JobId,
    SHOWUIPARAMS* pUIParams,
    DWORD* pResponse
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SPOOLSS.dll", ExactSpelling = true)]
static extern bool SplPromptUIInUsersSession(
    PRINTER_HANDLE hPrinter,   // PRINTER_HANDLE
    uint JobId,   // DWORD
    IntPtr pUIParams,   // SHOWUIPARAMS*
    out uint pResponse   // DWORD* out
);
<DllImport("SPOOLSS.dll", ExactSpelling:=True)>
Public Shared Function SplPromptUIInUsersSession(
    hPrinter As PRINTER_HANDLE,   ' PRINTER_HANDLE
    JobId As UInteger,   ' DWORD
    pUIParams As IntPtr,   ' SHOWUIPARAMS*
    <Out> ByRef pResponse As UInteger   ' DWORD* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' hPrinter : PRINTER_HANDLE
' JobId : DWORD
' pUIParams : SHOWUIPARAMS*
' pResponse : DWORD* out
Declare PtrSafe Function SplPromptUIInUsersSession Lib "spoolss" ( _
    ByVal hPrinter As LongPtr, _
    ByVal JobId As Long, _
    ByVal pUIParams As LongPtr, _
    ByRef pResponse As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SplPromptUIInUsersSession = ctypes.windll.spoolss.SplPromptUIInUsersSession
SplPromptUIInUsersSession.restype = wintypes.BOOL
SplPromptUIInUsersSession.argtypes = [
    PRINTER_HANDLE,  # hPrinter : PRINTER_HANDLE
    wintypes.DWORD,  # JobId : DWORD
    ctypes.c_void_p,  # pUIParams : SHOWUIPARAMS*
    ctypes.POINTER(wintypes.DWORD),  # pResponse : DWORD* out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	spoolss = windows.NewLazySystemDLL("SPOOLSS.dll")
	procSplPromptUIInUsersSession = spoolss.NewProc("SplPromptUIInUsersSession")
)

// hPrinter (PRINTER_HANDLE), JobId (DWORD), pUIParams (SHOWUIPARAMS*), pResponse (DWORD* out)
r1, _, err := procSplPromptUIInUsersSession.Call(
	uintptr(hPrinter),
	uintptr(JobId),
	uintptr(pUIParams),
	uintptr(pResponse),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function SplPromptUIInUsersSession(
  hPrinter: PRINTER_HANDLE;   // PRINTER_HANDLE
  JobId: DWORD;   // DWORD
  pUIParams: Pointer;   // SHOWUIPARAMS*
  pResponse: Pointer   // DWORD* out
): BOOL; stdcall;
  external 'SPOOLSS.dll' name 'SplPromptUIInUsersSession';
result := DllCall("SPOOLSS\SplPromptUIInUsersSession"
    , "Ptr", hPrinter   ; PRINTER_HANDLE
    , "UInt", JobId   ; DWORD
    , "Ptr", pUIParams   ; SHOWUIPARAMS*
    , "Ptr", pResponse   ; DWORD* out
    , "Int")   ; return: BOOL
●SplPromptUIInUsersSession(hPrinter, JobId, pUIParams, pResponse) = DLL("SPOOLSS.dll", "bool SplPromptUIInUsersSession(void*, dword, void*, void*)")
# 呼び出し: SplPromptUIInUsersSession(hPrinter, JobId, pUIParams, pResponse)
# hPrinter : PRINTER_HANDLE -> "void*"
# JobId : DWORD -> "dword"
# pUIParams : SHOWUIPARAMS* -> "void*"
# pResponse : DWORD* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef SplPromptUIInUsersSessionNative = Int32 Function(PRINTER_HANDLE, Uint32, Pointer<Void>, Pointer<Uint32>);
typedef SplPromptUIInUsersSessionDart = int Function(int, int, Pointer<Void>, Pointer<Uint32>);
final SplPromptUIInUsersSession = DynamicLibrary.open('SPOOLSS.dll')
    .lookupFunction<SplPromptUIInUsersSessionNative, SplPromptUIInUsersSessionDart>('SplPromptUIInUsersSession');
// hPrinter : PRINTER_HANDLE -> PRINTER_HANDLE
// JobId : DWORD -> Uint32
// pUIParams : SHOWUIPARAMS* -> Pointer<Void>
// pResponse : DWORD* out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SplPromptUIInUsersSession(
  hPrinter: PRINTER_HANDLE;   // PRINTER_HANDLE
  JobId: DWORD;   // DWORD
  pUIParams: Pointer;   // SHOWUIPARAMS*
  pResponse: Pointer   // DWORD* out
): BOOL; stdcall;
  external 'SPOOLSS.dll' name 'SplPromptUIInUsersSession';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let splpromptuiinuserssession =
  foreign "SplPromptUIInUsersSession"
    (PRINTER_HANDLE @-> uint32_t @-> (ptr void) @-> (ptr uint32_t) @-> returning int32_t)
(* hPrinter : PRINTER_HANDLE -> PRINTER_HANDLE *)
(* JobId : DWORD -> uint32_t *)
(* pUIParams : SHOWUIPARAMS* -> (ptr void) *)
(* pResponse : DWORD* out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library spoolss (t "SPOOLSS.dll"))
(cffi:use-foreign-library spoolss)

(cffi:defcfun ("SplPromptUIInUsersSession" spl-prompt-uiin-users-session :convention :stdcall) :int32
  (h-printer (:struct printer-handle))   ; PRINTER_HANDLE
  (job-id :uint32)   ; DWORD
  (p-uiparams :pointer)   ; SHOWUIPARAMS*
  (p-response :pointer))   ; DWORD* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SplPromptUIInUsersSession = Win32::API::More->new('SPOOLSS',
    'BOOL SplPromptUIInUsersSession(LPVOID hPrinter, DWORD JobId, LPVOID pUIParams, LPVOID pResponse)');
# my $ret = $SplPromptUIInUsersSession->Call($hPrinter, $JobId, $pUIParams, $pResponse);
# hPrinter : PRINTER_HANDLE -> LPVOID
# JobId : DWORD -> DWORD
# pUIParams : SHOWUIPARAMS* -> LPVOID
# pResponse : DWORD* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型