AddPrinterW

関数

プリンタサーバーに新しいプリンタを追加する(Unicode版)。

DLLwinspool.drv文字セットUnicode (-W)呼出規約winapiSetLastErrorあり

シグネチャ

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

PRINTER_HANDLE AddPrinterW(
    LPCWSTR pName,   // optional
    DWORD Level,
    BYTE* pPrinter
);

パラメーター

名前	型	方向	説明
pName	LPCWSTR	inoptional	プリンターを追加するサーバー名を指すポインタ。ローカル追加ならNULLを指定する。
Level	DWORD	in	pPrinterが指す構造体のバージョン。通常はPRINTER_INFO_2を表す2を指定する。
pPrinter	BYTE*	in	追加するプリンターの設定を格納したPRINTER_INFO_2等の構造体へのポインタ。

戻り値の型: PRINTER_HANDLE

公式ドキュメント

AddPrinter 関数は、指定されたサーバーがサポートするプリンターの一覧にプリンターを追加します。

戻り値

関数が成功した場合、戻り値は新しいプリンターオブジェクトへのハンドル (スレッドセーフではありません) です。ハンドルの使用を終えたら、ClosePrinter 関数に渡して閉じてください。

関数が失敗した場合、戻り値は NULL です。

解説(Remarks)

このメソッドを DllMain 内で呼び出さないでください。

メモ

これはブロッキング関数 (同期関数) であり、すぐに戻らない場合があります。この関数が戻るまでの時間は、ネットワークの状態、印刷サーバーの構成、プリンタードライバーの実装など、アプリケーションの作成時には予測が難しい実行時の要因に依存します。ユーザーインターフェイスとのやり取りを管理するスレッドからこの関数を呼び出すと、アプリケーションが応答していないように見えることがあります。

呼び出し元は SeLoadDriverPrivilege を持っている必要があります。

返されるハンドルはスレッドセーフではありません。複数のスレッドで同時に使用する必要がある場合は、同期関数を使用して、プリンターハンドルへのアクセスを独自に同期する必要があります。独自のコードを記述しなくて済むように、アプリケーションは必要に応じてスレッドごとにプリンターハンドルを開くこともできます。

AddPrinter 関数を呼び出す前に設定できる PRINTER_INFO_2 構造体のメンバーは次のとおりです。

Attributes
pPrintProcessor
DefaultPriority
Priority
pComment
pSecurityDescriptor
pDatatype
pSepFile
pDevMode
pShareName
pLocation
StartTime
pParameters
UntilTime

PRINTER_INFO_2 構造体の Status、cJobs、AveragePPM の各メンバーは、GetPrinter 関数が使用するために予約されています。AddPrinter を呼び出す前に設定してはなりません。

pSecurityDescriptor が NULL の場合、システムはプリンターに既定のセキュリティ記述子を割り当てます。既定のセキュリティ記述子には次のアクセス許可が設定されます。

値	説明
Administrators と Power Users	印刷キューに対するフルコントロール。これらのグループのメンバーは、印刷、キューの管理 (キューの削除、セキュリティ記述子を含むキューの任意の設定の変更)、およびすべてのユーザーの印刷ジョブの管理 (ジョブの削除、一時停止、再開、再実行) を行えます。なお、Power Users は Windows XP Professional より前には存在しません。
Creator/Owner	自分のジョブを管理できます。つまり、ジョブを送信したユーザーは、自分のジョブを管理 (削除、一時停止、再開、再実行) できます。
Everyone	実行と標準的な読み取り制御。つまり、Everyone グループのメンバーは、印刷キューに対して印刷を行い、そのプロパティを読み取ることができます。

アプリケーションが AddPrinter 関数でプリンターオブジェクトを作成した後は、PrinterProperties 関数を使用して、そのプリンターオブジェクトに関連付けられたプリンタードライバーの正しい設定を指定する必要があります。

同じ名前のプリンターオブジェクトが既に存在する場合、AddPrinter 関数はエラーを返します。ただし、そのオブジェクトが削除保留としてマークされている場合は除きます。その場合、既存のプリンターは削除されず、AddPrinter の作成パラメーターを使用して既存のプリンターの設定が変更されます (アプリケーションが SetPrinter 関数を使用した場合と同様です)。

サーバーにインストールされている印刷プロセッサの一覧を列挙するには、EnumPrintProcessors 関数を使用します。印刷プロセッサがサポートするデータ型の一覧を列挙するには、EnumPrintProcessorDatatypes 関数を使用します。使用可能なポートの一覧を列挙するには、EnumPorts 関数を使用します。インストールされているプリンタードライバーを列挙するには、EnumPrinterDrivers 関数を使用します。

AddPrinter 関数の呼び出し元は、プリンターを作成する対象のサーバーに対する SERVER_ACCESS_ADMINISTER アクセス権を持っている必要があります。この関数が返すハンドルは PRINTER_ALL_ACCESS のアクセス許可を持ち、プリンターに対する管理操作の実行に使用できます。

DrvPrinterEvent 関数に PRINTER_EVENT_FLAG_NO_UI フラグが渡された場合、ドライバーは DrvPrinterEvent の実行中に UI 呼び出しを使用しないでください。UI に関連する処理を行うには、インストーラーはプリンターの .inf ファイル内の VendorSetup エントリを使用するか、プラグアンドプレイデバイスの場合はデバイス固有の副インストーラー (co-installer) を使用できます。VendorSetup の詳細については、Microsoft Windows Driver Development Kit (DDK) を参照してください。

インターネット接続ファイアウォール (ICF) は既定でプリンターポートをブロックしますが、AddPrinter を実行すると、ファイルとプリンターの共有に対する例外が有効になります。

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

各言語での呼び出し定義

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

PRINTER_HANDLE AddPrinterW(
    LPCWSTR pName,   // optional
    DWORD Level,
    BYTE* pPrinter
);

[DllImport("winspool.drv", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern PRINTER_HANDLE AddPrinterW(
    [MarshalAs(UnmanagedType.LPWStr)] string pName,   // LPCWSTR optional
    uint Level,   // DWORD
    IntPtr pPrinter   // BYTE*
);

<DllImport("winspool.drv", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function AddPrinterW(
    <MarshalAs(UnmanagedType.LPWStr)> pName As String,   ' LPCWSTR optional
    Level As UInteger,   ' DWORD
    pPrinter As IntPtr   ' BYTE*
) As PRINTER_HANDLE
End Function

' pName : LPCWSTR optional
' Level : DWORD
' pPrinter : BYTE*
Declare PtrSafe Function AddPrinterW Lib "winspool.drv" ( _
    ByVal pName As LongPtr, _
    ByVal Level As Long, _
    ByVal pPrinter As LongPtr) As LongPtr
' 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

AddPrinterW = ctypes.windll.LoadLibrary("winspool.drv").AddPrinterW
AddPrinterW.restype = ctypes.c_void_p
AddPrinterW.argtypes = [
    wintypes.LPCWSTR,  # pName : LPCWSTR optional
    wintypes.DWORD,  # Level : DWORD
    ctypes.POINTER(ctypes.c_ubyte),  # pPrinter : BYTE*
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('winspool.drv')
AddPrinterW = Fiddle::Function.new(
  lib['AddPrinterW'],
  [
    Fiddle::TYPE_VOIDP,  # pName : LPCWSTR optional
    -Fiddle::TYPE_INT,  # Level : DWORD
    Fiddle::TYPE_VOIDP,  # pPrinter : BYTE*
  ],
  Fiddle::TYPE_VOIDP)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "winspool.drv")]
extern "system" {
    fn AddPrinterW(
        pName: *const u16,  // LPCWSTR optional
        Level: u32,  // DWORD
        pPrinter: *mut u8  // BYTE*
    ) -> PRINTER_HANDLE;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("winspool.drv", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern PRINTER_HANDLE AddPrinterW([MarshalAs(UnmanagedType.LPWStr)] string pName, uint Level, IntPtr pPrinter);
"@
$api = Add-Type -MemberDefinition $sig -Name 'winspool.drv_AddPrinterW' -Namespace Win32 -PassThru
# $api::AddPrinterW(pName, Level, pPrinter)

#uselib "winspool.drv"
#func global AddPrinterW "AddPrinterW" wptr, wptr, wptr
; AddPrinterW pName, Level, varptr(pPrinter)   ; 戻り値は stat
; pName : LPCWSTR optional -> "wptr"
; Level : DWORD -> "wptr"
; pPrinter : BYTE* -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "winspool.drv"
#cfunc global AddPrinterW "AddPrinterW" wstr, int, var
; res = AddPrinterW(pName, Level, pPrinter)
; pName : LPCWSTR optional -> "wstr"
; Level : DWORD -> "int"
; pPrinter : BYTE* -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "winspool.drv"
#cfunc global AddPrinterW "AddPrinterW" wstr, int, sptr
; res = AddPrinterW(pName, Level, varptr(pPrinter))
; pName : LPCWSTR optional -> "wstr"
; Level : DWORD -> "int"
; pPrinter : BYTE* -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。