GetDefaultPrinter 関数
GetDefaultPrinter 関数は、ローカル コンピューター上の現在のユーザーの既定のプリンターのプリンター名を取得します。
構文
BOOL GetDefaultPrinter(
_In_ LPTSTR pszBuffer,
_Inout_ LPDWORD pcchBuffer
);
パラメーター
-
pszBuffer [in]
-
既定のプリンター名を含む null で終わる文字列を受け取るバッファーへのポインター。 このパラメーターが NULL の場合、関数は失敗し、 pcchBuffer が指す変数は必要なバッファー サイズを文字で返します。
-
pcchBuffer [in, out]
-
入力時に、 pszBuffer バッファーのサイズを文字単位で指定します。 出力時に、プリンター名文字列のサイズ (終端の null 文字を含む) を文字単位で受け取ります。
戻り値
関数が成功した場合、戻り値は 0 以外の値であり、 pcchBuffer によって指される変数には、 pszBuffer バッファーにコピーされた文字数 (終端の null 文字を含む) が含まれます。
関数が失敗した場合は、0 を返します。
値 | 説明 |
---|---|
ERROR_INSUFFICIENT_BUFFER | pszBuffer バッファーが小さすぎます。 pcchBuffer が指す変数には、必要なバッファー サイズが文字で格納されます。 |
ERROR_FILE_NOT_FOUND | 既定のプリンターはありません。 |
注釈
注意
これはブロック関数または同期関数であり、すぐには返されない場合があります。 この関数が返す速度は、アプリケーションの作成時に予測が困難なネットワーク状態、プリント サーバーの構成、プリンター ドライバーの実装要因などの実行時の要因によって異なります。 ユーザー インターフェイスとの対話を管理するスレッドからこの関数を呼び出すと、アプリケーションが応答しなくなる可能性があります。
要件
要件 | 値 |
---|---|
サポートされている最小のクライアント |
Windows 2000 Professional [デスクトップ アプリのみ] |
サポートされている最小のサーバー |
Windows 2000 Server [デスクトップ アプリのみ] |
ヘッダー |
|
ライブラリ |
|
[DLL] |
|
Unicode 名と ANSI 名 |
GetDefaultPrinterW (Unicode) と GetDefaultPrinterA (ANSI) |