CDC::AbortDoc
更新 : 2007 年 11 月
現在の印刷ジョブを終了し、アプリケーションが最後に StartDoc メンバ関数を呼び出した後に書き込んだすべての情報を消去します。
int AbortDoc( );
戻り値
正常終了した場合は、正の値または 0 を返します。エラー終了した場合は、負の値を返します。次によく起きるエラーの値を一覧で示します。
SP_ERROR 一般的なエラーです。
SP_OUTOFDISK 現在、スプールに必要なディスク領域が十分でなく、領域が回復される見込みがないことを示します。
SP_OUTOFMEMORY スプールに必要なメモリが十分にないことを示します。
SP_USERABORT ユーザーがプリント マネージャを使ってジョブを終了させたことを示します。
解説
このメンバ関数は ABORTDOC プリンタ エスケープに変換されます。
AbortDoc は、次の操作を終了するために使います。
SetAbortProc を使ってアボート関数が指定されていない印刷操作
最初の NEWFRAME または NEXTBAND エスケープ呼び出しに到達していない印刷操作
アプリケーションが印刷エラーや印刷操作の取り消しを検出したときは、CDC クラスの EndDoc メンバ関数または AbortDoc メンバ関数を使って操作を終了させることはできません。GDI はエラー値を返す前に、自動的に操作を終了します。
印刷操作の取り消しを許可するためにダイアログ ボックスを表示したとき、アプリケーションはダイアログ ボックスを破棄する前に AbortDoc を呼び出す必要があります。
印刷ジョブを開始するためにプリント マネージャを使ったときは、AbortDoc を呼び出すとすべてのスプール ジョブが消去されます。このとき、プリンタは何も受け取りません。印刷ジョブを開始するためにプリント マネージャを使わなかったときは、AbortDoc を呼び出す前にプリンタにデータが送られてしまう可能性があります。このとき、プリンタ ドライバは (可能ならば) プリンタをリセットし、印刷ジョブを閉じます。
使用例
「CDC::StartDoc」の例を参照してください。
必要条件
ヘッダー : afxwin.h