AbortPrinter 関数
プリンターがスプール用に構成されている場合、 AbortPrinter 関数はプリンターのスプール・ファイルを削除します。
構文
BOOL AbortPrinter(
_In_ HANDLE hPrinter
);
パラメーター
-
hPrinter [in]
-
スプール・ファイルの削除元のプリンターへのハンドル。 プリンター ハンドルを取得するには 、OpenPrinter または AddPrinter 関数を使用します。
戻り値
関数が成功した場合、戻り値は 0 以外の値になります。
関数が失敗した場合は、0 を返します。
注釈
注意
これはブロック関数または同期関数であり、すぐには返されない可能性があります。 この関数が返す速度は、ネットワーク状態、プリント サーバーの構成、プリンター ドライバーの実装要因など、アプリケーションの作成時に予測が困難な実行時の要因によって異なります。 ユーザー インターフェイスとの対話を管理するスレッドからこの関数を呼び出すと、アプリケーションが応答しなくなる可能性があります。
プリンターがスプール用に構成されていない場合、 AbortPrinter 関数は無効です。
印刷ジョブのシーケンスは次のとおりです。
- 印刷ジョブを開始するには、 StartDocPrinter を呼び出します。
- 各ページを開始するには、 StartPagePrinter を呼び出します。
- ページにデータを書き込むには、 WritePrinter を呼び出します。
- 各ページを終了するには、 EndPagePrinter を呼び出します。
- 必要な数のページに対して 2、3、4 を繰り返します。
- 印刷ジョブを終了するには、 EndDocPrinter を呼び出します。
スプール・ファイル内のページが約 350 MB を超えると、印刷に失敗し、エラー・メッセージが送信されないことがあります。 たとえば、これは、大きな EMF ファイルを印刷するときに発生する可能性があります。 ページ サイズの制限は、使用可能な仮想メモリの量、プロセスの呼び出しによって割り当てられたメモリの量、プロセス ヒープ内の断片化の量など、多くの要因によって異なります。
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント |
Windows 2000 Professional [デスクトップ アプリのみ] |
| サポートされている最小のサーバー |
Windows 2000 Server [デスクトップ アプリのみ] |
| ヘッダー |
|
| ライブラリ |
|
| [DLL] |
|