SetPrinterDataEx 関数

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

構文

DWORD SetPrinterDataEx(
  _In_ HANDLE  hPrinter,
  _In_ LPCTSTR pKeyName,
  _In_ LPCTSTR pValueName,
  _In_ DWORD   Type,
  _In_ LPBYTE  pData,
  _In_ DWORD   cbData
);

パラメーター

hPrinter [in]

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

pKeyName [in]

設定する値を含むキーを指定する null で終わる文字列へのポインター。 指定したキーまたはサブキーが存在しない場合、関数によって作成されます。

ディレクトリ サービス (DS) で発行できる構成データを格納するには、次の定義済みレジストリ キーのいずれかを指定します。

値	説明
SPLDS_DRIVER_KEY	プリンター ドライバーは、このキーを使用してドライバーのプロパティを格納します。
SPLDS_SPOOLER_KEY	予約済み。 内部スプーラー プロパティを格納するために印刷スプーラーによってのみ使用されます。
SPLDS_USER_KEY	アプリケーションでは、このキーを使用して、プリンター資産番号などのプリンター プロパティを格納します。

SPLDS_USER_KEY キーの下に格納される値は、スキーマに対応するプロパティがある場合にのみ、ディレクトリ サービスに発行されます。 ドメイン管理者は、まだ存在しない場合は、プロパティを作成する必要があります。 SetPrinterDataEx を使用して値を追加または変更した後にユーザー定義プロパティを発行するには、Level = 7 の SetPrinter を呼び出し、PRINTER_INFO_7 dwAction メンバーを DSPRINT_UPDATEに設定します。

DS 以外の構成データを格納する他のキーを指定できます。 区切り記号として円記号 ( \ ) 文字を使用して、1 つ以上のサブキーを持つパスを指定します。

hPrinter がプリンターのハンドルで、pKeyName が NULL または空の文字列である場合、SetPrinterDataEx はERROR_INVALID_PARAMETERを返します。

hPrinter がプリント サーバーへのハンドルである場合、pKeyName は無視されます。

SPLDS_SPOOLER_KEYは使用しないでください。 スプーラー プリンターのプロパティを変更するには、Level = 2 の SetPrinter を使用します。

pValueName [in]

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

プリンターの場合、この文字列は pKeyName キーの値の名前を指定します。

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

「in」と入力します

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

pKeyName で定義済みのディレクトリ サービス キーのいずれかを指定する場合、Type はREG_SZ、REG_MULTI_SZ、REG_DWORD、またはREG_BINARYである必要があります。 REG_BINARYを使用する場合、cbData は 1 に等しく、ディレクトリ サービスはデータをブール値として扱います。

pData [in]

プリンター構成データを含むバッファーへのポインター。

cbData [in]

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

戻り値

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

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

解説

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

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

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

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

SPLREG_RESTART_JOB_ON_POOL_ERRORで指定された時間は最小時間です。 実際の時間は、次のポート モニター設定 (このレジストリ キーの下のレジストリ値) に応じて、長くなる可能性があります。

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

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

スプーラーがプール内の次に使用可能なプリンターにジョブをリダイレクトするには (設定時間内に印刷ジョブが印刷されない場合)、ポート モニターは SNMP をサポートする必要があり、プール内のネットワーク ポートは "SNMP 状態が有効" として構成されている必要があります。SNMP をサポートするポート モニターは、Standard TCP/IP ポート モニターです。

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

必要条件

関連項目

印刷

印刷スプーラー API 関数

GetPrinterDataEx

OpenPrinter

SetPrinter

PRINTER_INFO_7