SetPrinterData 関数

  • [アーティクル]

SetPrinterData 関数は、プリンターまたはプリント サーバーの構成データを設定します。

データを格納するレジストリ キーを指定するには、 SetPrinterDataEx 関数を呼び出します。 SetPrinterData の呼び出しは、pKeyName パラメーターを "PrinterDriverData" に設定して SetPrinterDataEx 関数を呼び出すことと同じです。

構文

DWORD SetPrinterData(
  _In_ HANDLE hPrinter,
  _In_ LPTSTR pValueName,
  _In_ DWORD  Type,
  _In_ LPBYTE pData,
  _In_ DWORD  cbData
);

パラメーター

hPrinter [in]

関数が構成データを設定するプリンターまたはプリント サーバーへのハンドル。 プリンター ハンドルを取得するには、 OpenPrinter、 OpenPrinter2、または AddPrinter 関数を使用します。

pValueName [in]

設定するデータを識別する null で終わる文字列へのポインター。

プリンターの場合、この文字列は、レジストリ内のプリンターの "PrinterDriverData" キーの下にあるレジストリ値の名前です。

プリント サーバーの場合、この文字列は、次の「解説」セクションに記載されている定義済みの文字列の 1 つです。

「入力」と入力します

pData パラメーターが指すデータの種類を示すコード。 使用できる型コードの一覧については、「 レジストリ値の型」を参照してください。

pData [in]

プリンター構成データを含むバイト配列へのポインター。

cbData [in]

配列のサイズ (バイト単位)。

戻り値

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

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

解説

注意

これはブロック関数または同期関数であり、すぐには返されない可能性があります。 この関数が返す速度は、ネットワーク状態、プリント サーバーの構成、プリンター ドライバーの実装要因など、アプリケーションの作成時に予測が困難な実行時の要因によって異なります。 ユーザー インターフェイスとの対話を管理するスレッドからこの関数を呼び出すと、アプリケーションが応答しなくなる可能性があります。

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

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

値 説明
SPLREG_ALLOW_USER_MANAGEFORMS Service Pack 2 (SP2) 以降の Windows XP
Windows Server 2003 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 ポート モニターがスプーラーをポートの状態で更新する間隔を分単位で指定します。

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

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

必要条件

要件 値
サポートされている最小のクライアント
 Windows 2000 Professional [デスクトップ アプリのみ]
サポートされている最小のサーバー
 Windows 2000 Server [デスクトップ アプリのみ]
ヘッダー
Winspool.h (Windows.h を含む)
ライブラリ
Winspool.lib
[DLL]
Winspool.drv
Unicode 名と ANSI 名
 SetPrinterDataW (Unicode) と SetPrinterDataA (ANSI)

関連項目

印刷

印刷スプーラー API 関数

GetPrinter

GetPrinterData

GetPrinterDataEx

OpenPrinter

SetPrinterDataEx