ホーム › Graphics.Printing › SetPrinterDataExA

SetPrinterDataExA

関数

指定キー配下のプリンター構成データ値を設定する。

DLLwinspool.drv文字セットANSI (-A)呼出規約winapi

シグネチャ

// winspool.drv  (ANSI / -A)
#include <windows.h>

DWORD SetPrinterDataExA(
    PRINTER_HANDLE hPrinter,
    LPCSTR pKeyName,
    LPCSTR pValueName,
    DWORD Type,
    BYTE* pData,
    DWORD cbData
);

パラメーター

名前	型	方向	説明
hPrinter	PRINTER_HANDLE	in	設定値を書き込む対象プリンターのハンドル。
pKeyName	LPCSTR	in	値を格納するレジストリキーのパスを指すポインタ。
pValueName	LPCSTR	in	設定する値の名前を指すポインタ。
Type	DWORD	in	値のデータ型を示すREG_SZ等のレジストリ型定数。
pData	BYTE*	in	書き込む値データを格納したバッファへのポインタ。
cbData	DWORD	in	書き込むデータのサイズ(バイト単位)。

戻り値の型: DWORD

公式ドキュメント

SetPrinterDataEx 関数は、プリンターまたはプリントサーバーの構成データを設定します。この関数は、構成データをプリンターのレジストリキーの下に格納します。

戻り値

関数が成功した場合、戻り値は ERROR_SUCCESS です。

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

解説(Remarks)

メモ

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

プリンターまたはプリントスプーラーの既存の構成データを取得するには、GetPrinterDataEx 関数を呼び出します。

pKeyName パラメーターに "PrinterDriverData" を指定して SetPrinterDataEx を呼び出すことは、SetPrinterData 関数を呼び出すことと同等です。

hPrinter がプリントサーバーへのハンドルである場合、pValueName には次の定義済みの値のいずれかを指定できます。

値	コメント
SPLREG_ALLOW_USER_MANAGEFORMS	Windows XP with Service Pack 2 (SP2) 以降 Windows Server 2003 with Service Pack 1 (SP1) 以降
SPLREG_BEEP_ENABLED
SPLREG_DEFAULT_SPOOL_DIRECTORY
SPLREG_EVENT_LOG
SPLREG_NET_POPUP	Windows Server 2003 以降ではサポートされません
SPLREG_PORT_THREAD_PRIORITY_DEFAULT
SPLREG_PORT_THREAD_PRIORITY
SPLREG_PRINT_DRIVER_ISOLATION_GROUPS	Windows 7 以降
SPLREG_PRINT_DRIVER_ISOLATION_TIME_BEFORE_RECYCLE	Windows 7 以降
SPLREG_PRINT_DRIVER_ISOLATION_MAX_OBJECTS_BEFORE_RECYCLE	Windows 7 以降
SPLREG_PRINT_DRIVER_ISOLATION_IDLE_TIMEOUT	Windows 7 以降
SPLREG_PRINT_DRIVER_ISOLATION_EXECUTION_POLICY	Windows 7 以降
SPLREG_PRINT_DRIVER_ISOLATION_OVERRIDE_POLICY	Windows 7 以降
SPLREG_RETRY_POPUP	正常に終了した場合、サーバーがすべてのジョブに対してポップアップウィンドウの再試行を行う設定であれば pData に 1 が格納され、行わない設定であれば 0 が格納されます。 Windows Server 2003 以降ではサポートされません
SPLREG_SCHEDULER_THREAD_PRIORITY
SPLREG_SCHEDULER_THREAD_PRIORITY_DEFAULT
SPLREG_WEBSHAREMGMT	Windows Server 2003 以降

次の定義済みの値のいずれかを pValueName として渡すと、エラーが発生したときのプール印刷の動作を設定します。

値	コメント
SPLREG_RESTART_JOB_ON_POOL_ERROR	pData の値は、エラーの発生後に別のポートでジョブを再開するまでの時間を秒単位で示します。この設定は SPLREG_RESTART_JOB_ON_POOL_ENABLED と組み合わせて使用します。
SPLREG_RESTART_JOB_ON_POOL_ENABLED	pData が 0 以外の値の場合、SPLREG_RESTART_JOB_ON_POOL_ERROR が有効であることを示します。

SPLREG_RESTART_JOB_ON_POOL_ERROR で指定した時間は最小の時間です。実際の時間は、次のポートモニターの設定によってこれより長くなる場合があります。これらの設定は、次のレジストリキーの下にあるレジストリ値です。

HKLM\SYSTEM\CurrentControlSet\Control\Print\Monitors\<*MonitorName*>\Ports

これらの値を設定するには、RegSetValueEx 関数を呼び出します。

ポートモニターの設定	データ型	意味
StatusUpdateEnabled	REG_DWORD	0 以外の値の場合、ポートモニターがポートの状態をスプーラーに通知して更新できるようにします。
StatusUpdateInterval	REG_DWORD	ポートモニターがポートの状態をスプーラーに通知して更新する間隔を分単位で指定します。

設定した時間内に印刷ジョブが印刷されなかった場合に、スプーラーがプール内の次に使用可能なプリンターへジョブをリダイレクトするようにするには、ポートモニターが SNMP をサポートしており、かつプール内のネットワークポートが「SNMP ステータス有効」として構成されている必要があります。SNMP をサポートするポートモニターは、標準 TCP/IP ポートモニターです。

Windows 7 以降のバージョンの Windows では、プリントサーバーに送信された印刷ジョブは、既定でクライアント側でレンダリングされます。印刷ジョブのクライアント側レンダリングは、pKeyName に "PrinterDriverData" を、pValueName に次の表の設定値を指定することで構成できます。

設定	データ型	説明
EMFDespoolingSetting	REG_DWORD	値が 0 の場合、またはこの値がレジストリに存在しない場合は、既定の印刷ジョブのクライアント側レンダリングが有効になります。値が 1 の場合は、印刷ジョブのクライアント側レンダリングが無効になります。
ForceClientSideRendering	REG_DWORD	値が 0 の場合、またはこの値がレジストリに存在しない場合は、印刷ジョブはクライアントでレンダリングされます。印刷ジョブをクライアントでレンダリングできない場合は、サーバーでレンダリングされます。印刷ジョブをサーバーでもレンダリングできない場合は失敗します。値が 1 の場合は、印刷ジョブはクライアントでレンダリングされます。印刷ジョブをクライアントでレンダリングできない場合は失敗します。

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

各言語での呼び出し定義

// winspool.drv  (ANSI / -A)
#include <windows.h>

DWORD SetPrinterDataExA(
    PRINTER_HANDLE hPrinter,
    LPCSTR pKeyName,
    LPCSTR pValueName,
    DWORD Type,
    BYTE* pData,
    DWORD cbData
);

[DllImport("winspool.drv", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint SetPrinterDataExA(
    PRINTER_HANDLE hPrinter,   // PRINTER_HANDLE
    [MarshalAs(UnmanagedType.LPStr)] string pKeyName,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] string pValueName,   // LPCSTR
    uint Type,   // DWORD
    IntPtr pData,   // BYTE*
    uint cbData   // DWORD
);

<DllImport("winspool.drv", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function SetPrinterDataExA(
    hPrinter As PRINTER_HANDLE,   ' PRINTER_HANDLE
    <MarshalAs(UnmanagedType.LPStr)> pKeyName As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> pValueName As String,   ' LPCSTR
    Type As UInteger,   ' DWORD
    pData As IntPtr,   ' BYTE*
    cbData As UInteger   ' DWORD
) As UInteger
End Function

' hPrinter : PRINTER_HANDLE
' pKeyName : LPCSTR
' pValueName : LPCSTR
' Type : DWORD
' pData : BYTE*
' cbData : DWORD
Declare PtrSafe Function SetPrinterDataExA Lib "winspool.drv" ( _
    ByVal hPrinter As LongPtr, _
    ByVal pKeyName As String, _
    ByVal pValueName As String, _
    ByVal Type As Long, _
    ByVal pData As LongPtr, _
    ByVal cbData As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

SetPrinterDataExA = ctypes.windll.LoadLibrary("winspool.drv").SetPrinterDataExA
SetPrinterDataExA.restype = wintypes.DWORD
SetPrinterDataExA.argtypes = [
    PRINTER_HANDLE,  # hPrinter : PRINTER_HANDLE
    wintypes.LPCSTR,  # pKeyName : LPCSTR
    wintypes.LPCSTR,  # pValueName : LPCSTR
    wintypes.DWORD,  # Type : DWORD
    ctypes.POINTER(ctypes.c_ubyte),  # pData : BYTE*
    wintypes.DWORD,  # cbData : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('winspool.drv')
SetPrinterDataExA = Fiddle::Function.new(
  lib['SetPrinterDataExA'],
  [
    Fiddle::TYPE_VOIDP,  # hPrinter : PRINTER_HANDLE
    Fiddle::TYPE_VOIDP,  # pKeyName : LPCSTR
    Fiddle::TYPE_VOIDP,  # pValueName : LPCSTR
    -Fiddle::TYPE_INT,  # Type : DWORD
    Fiddle::TYPE_VOIDP,  # pData : BYTE*
    -Fiddle::TYPE_INT,  # cbData : DWORD
  ],
  -Fiddle::TYPE_INT)

#[link(name = "winspool.drv")]
extern "system" {
    fn SetPrinterDataExA(
        hPrinter: PRINTER_HANDLE,  // PRINTER_HANDLE
        pKeyName: *const u8,  // LPCSTR
        pValueName: *const u8,  // LPCSTR
        Type: u32,  // DWORD
        pData: *mut u8,  // BYTE*
        cbData: u32  // DWORD
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("winspool.drv", CharSet = CharSet.Ansi)]
public static extern uint SetPrinterDataExA(PRINTER_HANDLE hPrinter, [MarshalAs(UnmanagedType.LPStr)] string pKeyName, [MarshalAs(UnmanagedType.LPStr)] string pValueName, uint Type, IntPtr pData, uint cbData);
"@
$api = Add-Type -MemberDefinition $sig -Name 'winspool.drv_SetPrinterDataExA' -Namespace Win32 -PassThru
# $api::SetPrinterDataExA(hPrinter, pKeyName, pValueName, Type, pData, cbData)

#uselib "winspool.drv"
#func global SetPrinterDataExA "SetPrinterDataExA" sptr, sptr, sptr, sptr, sptr, sptr
; SetPrinterDataExA hPrinter, pKeyName, pValueName, Type, varptr(pData), cbData   ; 戻り値は stat
; hPrinter : PRINTER_HANDLE -> "sptr"
; pKeyName : LPCSTR -> "sptr"
; pValueName : LPCSTR -> "sptr"
; Type : DWORD -> "sptr"
; pData : BYTE* -> "sptr"
; cbData : DWORD -> "sptr"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "winspool.drv"
#cfunc global SetPrinterDataExA "SetPrinterDataExA" int, str, str, int, var, int
; res = SetPrinterDataExA(hPrinter, pKeyName, pValueName, Type, pData, cbData)
; hPrinter : PRINTER_HANDLE -> "int"
; pKeyName : LPCSTR -> "str"
; pValueName : LPCSTR -> "str"
; Type : DWORD -> "int"
; pData : BYTE* -> "var"
; cbData : DWORD -> "int"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "winspool.drv"
#cfunc global SetPrinterDataExA "SetPrinterDataExA" int, str, str, int, sptr, int
; res = SetPrinterDataExA(hPrinter, pKeyName, pValueName, Type, varptr(pData), cbData)
; hPrinter : PRINTER_HANDLE -> "int"
; pKeyName : LPCSTR -> "str"
; pValueName : LPCSTR -> "str"
; Type : DWORD -> "int"
; pData : BYTE* -> "sptr"
; cbData : DWORD -> "int"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。