SetDefaultPrinter 関数

SetDefaultPrinter 関数は、ローカル コンピューター上の現在のユーザーの既定のプリンターのプリンター名を設定します。

構文

BOOL SetDefaultPrinter(
  _In_ LPCTSTR pszPrinter
);

パラメーター

pszPrinter [in]

既定のプリンター名を含む null で終わる文字列へのポインター。 リモート プリンター接続の場合、名前の形式は **\\server\**printername です。 ローカル プリンターの場合、名前の形式は printername です。

このパラメーターが NULL または空の文字列 ("") の場合、 SetDefaultPrinter はインストールされているプリンターの 1 つから既定のプリンターを選択します。 既定のプリンターが既に存在する場合、このパラメーターに NULL または空の文字列を指定して SetDefaultPrinter を呼び出すと、既定のプリンターが変更される可能性があります。

戻り値

関数が成功した場合、戻り値は 0 以外の値になります。

関数が失敗した場合は、0 を返します。

解説

このメソッドを使用する場合は、有効なプリンター、ドライバー、ポートを指定する必要があります。 無効な場合、API は失敗しませんが、結果は定義されていません。 これにより、他のプログラムがプリンターを以前の有効なプリンターに戻す可能性があります。 EnumPrinters を使用して、使用可能なすべてのプリンターのプリンター名、ドライバー名、およびポート名を取得できます。

注意

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

必要条件

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

関連項目

印刷

印刷スプーラー API 関数

EnumPrinters

GetDefaultPrinter