Win32 API 日本語リファレンス
ホームUI.Shell › SHInvokePrinterCommandA

SHInvokePrinterCommandA

関数
プリンターの追加や接続などのコマンドを実行する。
DLLSHELL32.dll文字セットANSI (-A)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

// SHELL32.dll  (ANSI / -A)
#include <windows.h>

BOOL SHInvokePrinterCommandA(
    HWND hwnd,   // optional
    DWORD uAction,
    LPCSTR lpBuf1,
    LPCSTR lpBuf2,   // optional
    BOOL fModal
);

パラメーター

名前方向説明
hwndHWNDinoptional操作中に作成されるウィンドウやダイアログボックスの親ウィンドウのハンドルです。
uActionDWORDin

実行するプリンター操作の種類です。次のいずれかの値を指定します。

PRINTACTION_OPEN (0)

0x0。lpBuf1 で指定したプリンターを開きます。lpBuf2 パラメーターは無視されます。

PRINTACTION_PROPERTIES (1)

0x1。lpBuf1 で指定したプリンターのプロパティページを表示します。lpBuf2 パラメーターには NULL を指定するか、表示する特定のプロパティシートを名前または番号で指定できます。lpBuf2 の上位 WORD が 0 以外の場合、このパラメーターは開くシートの名前を含むバッファーへのポインターとみなされます。それ以外の場合、lpBuf2 は開くプロパティシートの 0 から始まるインデックスとして扱われます。

PRINTACTION_NETINSTALL (2)

0x2。lpBuf1 で指定したネットワークプリンターをインストールします。lpBuf2 パラメーターは無視されます。

PRINTACTION_NETINSTALLLINK (3)

0x3。lpBuf1 で指定したネットワークプリンターへのショートカットを作成します。lpBuf2 パラメーターには、ショートカットを作成するフォルダーのドライブとパスを指定します。ネットワークプリンターは、あらかじめローカルコンピューターにインストールされている必要があります。

PRINTACTION_TESTPAGE (4)

0x4。lpBuf1 で指定したプリンターでテストページを印刷します。lpBuf2 パラメーターは無視されます。

PRINTACTION_OPENNETPRN (5)

0x5。lpBuf1 で指定したネットワークプリンターを開きます。lpBuf2 パラメーターは無視されます。

PRINTACTION_DOCUMENTDEFAULTS (6)

0x6。lpBuf1 で指定したプリンターの既定のドキュメントプロパティを表示します。lpBuf2 パラメーターは無視されます。

PRINTACTION_SERVERPROPERTIES (7)

0x7。lpBuf1 で指定したプリンターサーバーのプロパティを表示します。lpBuf2 パラメーターは無視されます。

lpBuf1LPCSTRinプリンターコマンドの追加情報を含む null 終端文字列へのポインターです。このパラメーターに含まれる情報は uAction の値によって異なります。
lpBuf2LPCSTRinoptionalプリンターコマンドの追加情報を含む null 終端文字列へのポインターです。このパラメーターに含まれる情報は uAction の値によって異なります。
fModalBOOLinコマンドが完了するまで SHInvokePrinterCommand が制御を返さないようにするには TRUE を指定します。コマンドの初期化が完了した時点で関数が制御を返すようにするには FALSE を指定します。

戻り値の型: BOOL

公式ドキュメント

プリンターオブジェクトに対してコマンドを実行します。(ANSI)

戻り値

型: BOOL

成功した場合は TRUE を返します。それ以外の場合は FALSE を返します。

解説(Remarks)

lpBuf1 でプリンター名を指定する場合、その名前はローカルプリンターの名前、またはネットワークプリンターのサーバー名と共有名のいずれかを指定できます。ネットワークプリンター名を指定する場合は、次の形式で指定する必要があります。

"\\<server><shared printer name>"

この関数は Shell バージョン 4.71 以降で実装されています。以前の Shell バージョンとの下位互換性を維持するため、この関数を明示的に使用すべきではありません。代わりに、LoadLibrary 関数および GetProcAddress 関数を使用して関数のアドレスを取得してください。

メモ

shellapi.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして SHInvokePrinterCommand を定義します。エンコードに依存しないエイリアスの使用を、エンコードに依存しないわけではないコードと混在させると、不一致が生じてコンパイルエラーや実行時エラーの原因になることがあります。詳細については、関数プロトタイプの規約を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// SHELL32.dll  (ANSI / -A)
#include <windows.h>

BOOL SHInvokePrinterCommandA(
    HWND hwnd,   // optional
    DWORD uAction,
    LPCSTR lpBuf1,
    LPCSTR lpBuf2,   // optional
    BOOL fModal
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SHELL32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern bool SHInvokePrinterCommandA(
    IntPtr hwnd,   // HWND optional
    uint uAction,   // DWORD
    [MarshalAs(UnmanagedType.LPStr)] string lpBuf1,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] string lpBuf2,   // LPCSTR optional
    bool fModal   // BOOL
);
<DllImport("SHELL32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function SHInvokePrinterCommandA(
    hwnd As IntPtr,   ' HWND optional
    uAction As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPStr)> lpBuf1 As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> lpBuf2 As String,   ' LPCSTR optional
    fModal As Boolean   ' BOOL
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' hwnd : HWND optional
' uAction : DWORD
' lpBuf1 : LPCSTR
' lpBuf2 : LPCSTR optional
' fModal : BOOL
Declare PtrSafe Function SHInvokePrinterCommandA Lib "shell32" ( _
    ByVal hwnd As LongPtr, _
    ByVal uAction As Long, _
    ByVal lpBuf1 As String, _
    ByVal lpBuf2 As String, _
    ByVal fModal As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SHInvokePrinterCommandA = ctypes.windll.shell32.SHInvokePrinterCommandA
SHInvokePrinterCommandA.restype = wintypes.BOOL
SHInvokePrinterCommandA.argtypes = [
    wintypes.HANDLE,  # hwnd : HWND optional
    wintypes.DWORD,  # uAction : DWORD
    wintypes.LPCSTR,  # lpBuf1 : LPCSTR
    wintypes.LPCSTR,  # lpBuf2 : LPCSTR optional
    wintypes.BOOL,  # fModal : BOOL
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHELL32.dll')
SHInvokePrinterCommandA = Fiddle::Function.new(
  lib['SHInvokePrinterCommandA'],
  [
    Fiddle::TYPE_VOIDP,  # hwnd : HWND optional
    -Fiddle::TYPE_INT,  # uAction : DWORD
    Fiddle::TYPE_VOIDP,  # lpBuf1 : LPCSTR
    Fiddle::TYPE_VOIDP,  # lpBuf2 : LPCSTR optional
    Fiddle::TYPE_INT,  # fModal : BOOL
  ],
  Fiddle::TYPE_INT)
#[link(name = "shell32")]
extern "system" {
    fn SHInvokePrinterCommandA(
        hwnd: *mut core::ffi::c_void,  // HWND optional
        uAction: u32,  // DWORD
        lpBuf1: *const u8,  // LPCSTR
        lpBuf2: *const u8,  // LPCSTR optional
        fModal: i32  // BOOL
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SHELL32.dll", CharSet = CharSet.Ansi)]
public static extern bool SHInvokePrinterCommandA(IntPtr hwnd, uint uAction, [MarshalAs(UnmanagedType.LPStr)] string lpBuf1, [MarshalAs(UnmanagedType.LPStr)] string lpBuf2, bool fModal);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHELL32_SHInvokePrinterCommandA' -Namespace Win32 -PassThru
# $api::SHInvokePrinterCommandA(hwnd, uAction, lpBuf1, lpBuf2, fModal)
#uselib "SHELL32.dll"
#func global SHInvokePrinterCommandA "SHInvokePrinterCommandA" sptr, sptr, sptr, sptr, sptr
; SHInvokePrinterCommandA hwnd, uAction, lpBuf1, lpBuf2, fModal   ; 戻り値は stat
; hwnd : HWND optional -> "sptr"
; uAction : DWORD -> "sptr"
; lpBuf1 : LPCSTR -> "sptr"
; lpBuf2 : LPCSTR optional -> "sptr"
; fModal : BOOL -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "SHELL32.dll"
#cfunc global SHInvokePrinterCommandA "SHInvokePrinterCommandA" sptr, int, str, str, int
; res = SHInvokePrinterCommandA(hwnd, uAction, lpBuf1, lpBuf2, fModal)
; hwnd : HWND optional -> "sptr"
; uAction : DWORD -> "int"
; lpBuf1 : LPCSTR -> "str"
; lpBuf2 : LPCSTR optional -> "str"
; fModal : BOOL -> "int"
; BOOL SHInvokePrinterCommandA(HWND hwnd, DWORD uAction, LPCSTR lpBuf1, LPCSTR lpBuf2, BOOL fModal)
#uselib "SHELL32.dll"
#cfunc global SHInvokePrinterCommandA "SHInvokePrinterCommandA" intptr, int, str, str, int
; res = SHInvokePrinterCommandA(hwnd, uAction, lpBuf1, lpBuf2, fModal)
; hwnd : HWND optional -> "intptr"
; uAction : DWORD -> "int"
; lpBuf1 : LPCSTR -> "str"
; lpBuf2 : LPCSTR optional -> "str"
; fModal : BOOL -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	shell32 = windows.NewLazySystemDLL("SHELL32.dll")
	procSHInvokePrinterCommandA = shell32.NewProc("SHInvokePrinterCommandA")
)

// hwnd (HWND optional), uAction (DWORD), lpBuf1 (LPCSTR), lpBuf2 (LPCSTR optional), fModal (BOOL)
r1, _, err := procSHInvokePrinterCommandA.Call(
	uintptr(hwnd),
	uintptr(uAction),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(lpBuf1))),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(lpBuf2))),
	uintptr(fModal),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function SHInvokePrinterCommandA(
  hwnd: THandle;   // HWND optional
  uAction: DWORD;   // DWORD
  lpBuf1: PAnsiChar;   // LPCSTR
  lpBuf2: PAnsiChar;   // LPCSTR optional
  fModal: BOOL   // BOOL
): BOOL; stdcall;
  external 'SHELL32.dll' name 'SHInvokePrinterCommandA';
result := DllCall("SHELL32\SHInvokePrinterCommandA"
    , "Ptr", hwnd   ; HWND optional
    , "UInt", uAction   ; DWORD
    , "AStr", lpBuf1   ; LPCSTR
    , "AStr", lpBuf2   ; LPCSTR optional
    , "Int", fModal   ; BOOL
    , "Int")   ; return: BOOL
●SHInvokePrinterCommandA(hwnd, uAction, lpBuf1, lpBuf2, fModal) = DLL("SHELL32.dll", "bool SHInvokePrinterCommandA(void*, dword, char*, char*, bool)")
# 呼び出し: SHInvokePrinterCommandA(hwnd, uAction, lpBuf1, lpBuf2, fModal)
# hwnd : HWND optional -> "void*"
# uAction : DWORD -> "dword"
# lpBuf1 : LPCSTR -> "char*"
# lpBuf2 : LPCSTR optional -> "char*"
# fModal : BOOL -> "bool"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "shell32" fn SHInvokePrinterCommandA(
    hwnd: ?*anyopaque, // HWND optional
    uAction: u32, // DWORD
    lpBuf1: [*c]const u8, // LPCSTR
    lpBuf2: [*c]const u8, // LPCSTR optional
    fModal: i32 // BOOL
) callconv(std.os.windows.WINAPI) i32;
proc SHInvokePrinterCommandA(
    hwnd: pointer,  # HWND optional
    uAction: uint32,  # DWORD
    lpBuf1: cstring,  # LPCSTR
    lpBuf2: cstring,  # LPCSTR optional
    fModal: int32  # BOOL
): int32 {.importc: "SHInvokePrinterCommandA", stdcall, dynlib: "SHELL32.dll".}
pragma(lib, "shell32");
extern(Windows)
int SHInvokePrinterCommandA(
    void* hwnd,   // HWND optional
    uint uAction,   // DWORD
    const(char)* lpBuf1,   // LPCSTR
    const(char)* lpBuf2,   // LPCSTR optional
    int fModal   // BOOL
);
ccall((:SHInvokePrinterCommandA, "SHELL32.dll"), stdcall, Int32,
      (Ptr{Cvoid}, UInt32, Cstring, Cstring, Int32),
      hwnd, uAction, lpBuf1, lpBuf2, fModal)
# hwnd : HWND optional -> Ptr{Cvoid}
# uAction : DWORD -> UInt32
# lpBuf1 : LPCSTR -> Cstring
# lpBuf2 : LPCSTR optional -> Cstring
# fModal : BOOL -> Int32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t SHInvokePrinterCommandA(
    void* hwnd,
    uint32_t uAction,
    const char* lpBuf1,
    const char* lpBuf2,
    int32_t fModal);
]]
local shell32 = ffi.load("shell32")
-- shell32.SHInvokePrinterCommandA(hwnd, uAction, lpBuf1, lpBuf2, fModal)
-- hwnd : HWND optional
-- uAction : DWORD
-- lpBuf1 : LPCSTR
-- lpBuf2 : LPCSTR optional
-- fModal : BOOL
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('SHELL32.dll');
const SHInvokePrinterCommandA = lib.func('__stdcall', 'SHInvokePrinterCommandA', 'int32_t', ['void *', 'uint32_t', 'str', 'str', 'int32_t']);
// SHInvokePrinterCommandA(hwnd, uAction, lpBuf1, lpBuf2, fModal)
// hwnd : HWND optional -> 'void *'
// uAction : DWORD -> 'uint32_t'
// lpBuf1 : LPCSTR -> 'str'
// lpBuf2 : LPCSTR optional -> 'str'
// fModal : BOOL -> 'int32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("SHELL32.dll", {
  SHInvokePrinterCommandA: { parameters: ["pointer", "u32", "buffer", "buffer", "i32"], result: "i32" },
});
// lib.symbols.SHInvokePrinterCommandA(hwnd, uAction, lpBuf1, lpBuf2, fModal)
// hwnd : HWND optional -> "pointer"
// uAction : DWORD -> "u32"
// lpBuf1 : LPCSTR -> "buffer"
// lpBuf2 : LPCSTR optional -> "buffer"
// fModal : BOOL -> "i32"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SHInvokePrinterCommandA(
    void* hwnd,
    uint32_t uAction,
    const char* lpBuf1,
    const char* lpBuf2,
    int32_t fModal);
C, "SHELL32.dll");
// $ffi->SHInvokePrinterCommandA(hwnd, uAction, lpBuf1, lpBuf2, fModal);
// hwnd : HWND optional
// uAction : DWORD
// lpBuf1 : LPCSTR
// lpBuf2 : LPCSTR optional
// fModal : BOOL
// 構造体/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 Shell32 extends StdCallLibrary {
    Shell32 INSTANCE = Native.load("shell32", Shell32.class, W32APIOptions.ASCII_OPTIONS);
    boolean SHInvokePrinterCommandA(
        Pointer hwnd,   // HWND optional
        int uAction,   // DWORD
        String lpBuf1,   // LPCSTR
        String lpBuf2,   // LPCSTR optional
        boolean fModal   // BOOL
    );
}
@[Link("shell32")]
lib LibSHELL32
  fun SHInvokePrinterCommandA = SHInvokePrinterCommandA(
    hwnd : Void*,   # HWND optional
    uAction : UInt32,   # DWORD
    lpBuf1 : UInt8*,   # LPCSTR
    lpBuf2 : UInt8*,   # LPCSTR optional
    fModal : Int32   # BOOL
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef SHInvokePrinterCommandANative = Int32 Function(Pointer<Void>, Uint32, Pointer<Utf8>, Pointer<Utf8>, Int32);
typedef SHInvokePrinterCommandADart = int Function(Pointer<Void>, int, Pointer<Utf8>, Pointer<Utf8>, int);
final SHInvokePrinterCommandA = DynamicLibrary.open('SHELL32.dll')
    .lookupFunction<SHInvokePrinterCommandANative, SHInvokePrinterCommandADart>('SHInvokePrinterCommandA');
// hwnd : HWND optional -> Pointer<Void>
// uAction : DWORD -> Uint32
// lpBuf1 : LPCSTR -> Pointer<Utf8>
// lpBuf2 : LPCSTR optional -> Pointer<Utf8>
// fModal : BOOL -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SHInvokePrinterCommandA(
  hwnd: THandle;   // HWND optional
  uAction: DWORD;   // DWORD
  lpBuf1: PAnsiChar;   // LPCSTR
  lpBuf2: PAnsiChar;   // LPCSTR optional
  fModal: BOOL   // BOOL
): BOOL; stdcall;
  external 'SHELL32.dll' name 'SHInvokePrinterCommandA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SHInvokePrinterCommandA"
  c_SHInvokePrinterCommandA :: Ptr () -> Word32 -> CString -> CString -> CInt -> IO CInt
-- hwnd : HWND optional -> Ptr ()
-- uAction : DWORD -> Word32
-- lpBuf1 : LPCSTR -> CString
-- lpBuf2 : LPCSTR optional -> CString
-- fModal : BOOL -> CInt
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let shinvokeprintercommanda =
  foreign "SHInvokePrinterCommandA"
    ((ptr void) @-> uint32_t @-> string @-> string @-> int32_t @-> returning int32_t)
(* hwnd : HWND optional -> (ptr void) *)
(* uAction : DWORD -> uint32_t *)
(* lpBuf1 : LPCSTR -> string *)
(* lpBuf2 : LPCSTR optional -> string *)
(* fModal : BOOL -> int32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library shell32 (t "SHELL32.dll"))
(cffi:use-foreign-library shell32)

(cffi:defcfun ("SHInvokePrinterCommandA" shinvoke-printer-command-a :convention :stdcall) :int32
  (hwnd :pointer)   ; HWND optional
  (u-action :uint32)   ; DWORD
  (lp-buf1 :string)   ; LPCSTR
  (lp-buf2 :string)   ; LPCSTR optional
  (f-modal :int32))   ; BOOL
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SHInvokePrinterCommandA = Win32::API::More->new('SHELL32',
    'BOOL SHInvokePrinterCommandA(HANDLE hwnd, DWORD uAction, LPCSTR lpBuf1, LPCSTR lpBuf2, BOOL fModal)');
# my $ret = $SHInvokePrinterCommandA->Call($hwnd, $uAction, $lpBuf1, $lpBuf2, $fModal);
# hwnd : HWND optional -> HANDLE
# uAction : DWORD -> DWORD
# lpBuf1 : LPCSTR -> LPCSTR
# lpBuf2 : LPCSTR optional -> LPCSTR
# fModal : BOOL -> BOOL
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い