CDC::Escape
更新 : 2007 年 11 月
このメンバ関数は、Win32 プログラミングでの互換性のために残されています。
virtual int Escape(
int nEscape,
int nCount,
LPCSTR lpszInData,
LPVOID lpOutData
);
int Escape(
int nEscape,
int nInputSize,
LPCSTR lpszInputData,
int nOutputSize,
LPSTR lpszOutputData
);
パラメータ
nEscape
実行するエスケープ関数。エスケープ関数の一覧については、Windows SDK の「Escape」を参照してください。
nCount
パラメータ lpszInData により指定されるデータのバイト数。lpszInData
このエスケープに必要な入力データ構造体へのポインタ。lpOutData
このエスケープからの出力を受け取る構造体へのポインタ。データが返されないときは、パラメータ lpOutData を NULL にします。nInputSize
パラメータ lpszInputData で指されるデータのバイト数。lpszInputData
指定されたエスケープに必要な入力構造体へのポインタ。nOutputSize
パラメータ lpszOutputData で指されるデータのバイト数。lpszOutputData
このエスケープからの出力を受け取る構造体へのポインタ。データが返されないときは、このパラメータを NULL にします。
戻り値
関数が正常終了した場合は、正の値を返します。ただし、実装を調べるだけの場合の QUERYESCSUPPORT 描画エスケープは除きます。エスケープが実装されていない場合は、0 を返します。エラーが発生した場合は、負の値を返します。次によく起きるエラーの値を一覧で示します。
SP_ERROR 一般的なエラーです。
SP_OUTOFDISK 現在、スプールに必要なディスク領域が十分でなく、領域が回復される見込みがないことを示します。
SP_OUTOFMEMORY スプールに必要なメモリが十分にないことを示します。
SP_USERABORT ユーザーがプリント マネージャを使ってジョブを終了させたことを示します。
解説
オリジナルのプリンタ エスケープのうち、Win32 アプリケーションでサポートされるのは QUERYESCSUPPORT だけです。ほかのすべてのプリンタ エスケープは、16 ビット アプリケーションとの互換性のためだけに残され、サポートされています。
CDC では、Win32 プログラミングのためにプリンタ エスケープに代わる次の 6 つのメンバ関数を用意しました。
また、CDC::GetDeviceCaps は、ほかのプリンタ エスケープよりも優先される Win32 インデックスをサポートしています。詳細については、Windows SDK の「GetDeviceCaps」を参照してください。
このメンバ関数を使うと、アプリケーションは GDI を使っては直接利用できない特定のデバイスの機能にアクセスできるようになります。
アプリケーションが定義済みのエスケープ値を使用している場合は、最初の形式を使ってください。アプリケーションが独自のエスケープ値を定義している場合は、2 番目の形式を使ってください。2 番目の形式の詳細については、Windows SDK の「ExtEscape」を参照してください。
必要条件
ヘッダー : afxwin.h