ホーム › Graphics.Printing › GetPrinterDataExA

GetPrinterDataExA

関数

指定キー配下のプリンタ構成データ値を取得する(ANSI版)。

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

シグネチャ

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

DWORD GetPrinterDataExA(
    PRINTER_HANDLE hPrinter,
    LPCSTR pKeyName,
    LPCSTR pValueName,
    DWORD* pType,   // optional
    BYTE* pData,   // optional
    DWORD nSize,
    DWORD* pcbNeeded
);

パラメーター

名前	型	方向	説明
hPrinter	PRINTER_HANDLE	in	設定値を取得する対象プリンターのハンドル。
pKeyName	LPCSTR	in	値が格納されたレジストリキーのパスを指すポインタ。
pValueName	LPCSTR	in	取得する設定値の名前を指すポインタ。
pType	DWORD*	outoptional	値のデータ型を受け取る変数へのポインタ。NULL可。
pData	BYTE*	outoptional	取得した値データを受け取るバッファへのポインタ。
nSize	DWORD	in	pDataバッファのサイズ(バイト単位)。
pcbNeeded	DWORD*	out	必要なバイト数を受け取る変数へのポインタ。

戻り値の型: DWORD

公式ドキュメント

GetPrinterDataEx 関数は、指定したプリンターまたはプリントサーバーの構成データを取得します。

戻り値

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

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

解説(Remarks)

メモ

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

GetPrinterDataEx は、SetPrinterDataEx 関数および SetPrinterData 関数によって設定されたプリンター構成データを取得します。

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

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

値	コメント
SPLREG_ALLOW_USER_MANAGEFORMS	Windows XP with Service Pack 2 (SP2) 以降 Windows Server 2003 with Service Pack 1 (SP1) 以降
SPLREG_ARCHITECTURE
SPLREG_BEEP_ENABLED
SPLREG_DEFAULT_SPOOL_DIRECTORY
SPLREG_DNS_MACHINE_NAME
SPLREG_DS_PRESENT	正常に戻った場合、コンピューターが DS ドメインに参加していれば pData に 0x0001 が格納され、それ以外の場合は 0 が格納されます。
SPLREG_DS_PRESENT_FOR_USER	正常に戻った場合、ユーザーが DS ドメインにログオンしていれば pData に 0x0001 が格納され、それ以外の場合は 0 が格納されます。
SPLREG_EVENT_LOG
SPLREG_MAJOR_VERSION
SPLREG_MINOR_VERSION
SPLREG_NET_POPUP	Windows Server 2003 以降ではサポートされません
SPLREG_NET_POPUP_TO_COMPUTER	正常に戻った場合、ジョブ通知をクライアントコンピューターに送信する場合は pData に 1 が格納され、ユーザーに送信する場合は 0 が格納されます。 Windows Server 2003 以降ではサポートされません
SPLREG_OS_VERSION	Windows XP 以降
SPLREG_OS_VERSIONEX
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_REMOTE_FAX	正常に戻った場合、FAX サービスがリモートクライアントをサポートしていれば pData に 0x0001 が格納され、それ以外の場合は 0 が格納されます。
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

これらの値を照会するには、RegQueryValueEx 関数を呼び出します。

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

pKeyName が定義済みのディレクトリサービス (DS) キーのいずれかであり (SetPrinter を参照)、pValueName にコンマ (',') が含まれている場合、pValueName のコンマより前の部分が値名、コンマより後ろの部分が DS プロパティ OID になります。OID という名前のサブキーが作成され、値名と OID から成る新しい値が OID キーの下に登録されます。SetPrinterDataEx は、値名とデータを DS キーの下にも追加します。

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 GetPrinterDataExA(
    PRINTER_HANDLE hPrinter,
    LPCSTR pKeyName,
    LPCSTR pValueName,
    DWORD* pType,   // optional
    BYTE* pData,   // optional
    DWORD nSize,
    DWORD* pcbNeeded
);

[DllImport("winspool.drv", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint GetPrinterDataExA(
    PRINTER_HANDLE hPrinter,   // PRINTER_HANDLE
    [MarshalAs(UnmanagedType.LPStr)] string pKeyName,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] string pValueName,   // LPCSTR
    IntPtr pType,   // DWORD* optional, out
    IntPtr pData,   // BYTE* optional, out
    uint nSize,   // DWORD
    out uint pcbNeeded   // DWORD* out
);

<DllImport("winspool.drv", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function GetPrinterDataExA(
    hPrinter As PRINTER_HANDLE,   ' PRINTER_HANDLE
    <MarshalAs(UnmanagedType.LPStr)> pKeyName As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> pValueName As String,   ' LPCSTR
    pType As IntPtr,   ' DWORD* optional, out
    pData As IntPtr,   ' BYTE* optional, out
    nSize As UInteger,   ' DWORD
    <Out> ByRef pcbNeeded As UInteger   ' DWORD* out
) As UInteger
End Function

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

import ctypes
from ctypes import wintypes

GetPrinterDataExA = ctypes.windll.LoadLibrary("winspool.drv").GetPrinterDataExA
GetPrinterDataExA.restype = wintypes.DWORD
GetPrinterDataExA.argtypes = [
    PRINTER_HANDLE,  # hPrinter : PRINTER_HANDLE
    wintypes.LPCSTR,  # pKeyName : LPCSTR
    wintypes.LPCSTR,  # pValueName : LPCSTR
    ctypes.POINTER(wintypes.DWORD),  # pType : DWORD* optional, out
    ctypes.POINTER(ctypes.c_ubyte),  # pData : BYTE* optional, out
    wintypes.DWORD,  # nSize : DWORD
    ctypes.POINTER(wintypes.DWORD),  # pcbNeeded : DWORD* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('winspool.drv')
GetPrinterDataExA = Fiddle::Function.new(
  lib['GetPrinterDataExA'],
  [
    Fiddle::TYPE_VOIDP,  # hPrinter : PRINTER_HANDLE
    Fiddle::TYPE_VOIDP,  # pKeyName : LPCSTR
    Fiddle::TYPE_VOIDP,  # pValueName : LPCSTR
    Fiddle::TYPE_VOIDP,  # pType : DWORD* optional, out
    Fiddle::TYPE_VOIDP,  # pData : BYTE* optional, out
    -Fiddle::TYPE_INT,  # nSize : DWORD
    Fiddle::TYPE_VOIDP,  # pcbNeeded : DWORD* out
  ],
  -Fiddle::TYPE_INT)

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

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

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

出力引数:

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