IPrintOemDriverUni::D rvWriteAbortBuf メソッド (prcomoem.h)

  • [アーティクル]

このメソッドはIPrintOemDriverUni::DrvWriteAbortBuf、ユーザーが印刷ジョブを終了した後に、OEM レンダリング プラグインがプリンタークリーンアップ コードを送信できるようにするために、Unidrv ドライバーによって提供されます。

構文

HRESULT DrvWriteAbortBuf(
  PDEVOBJ pdevobj,
  PVOID   pBuffer,
  DWORD   cbSize,
  DWORD   dwWait
);

パラメーター

pdevobj

呼び出し元が指定した DEVOBJ 構造体へのポインター。

pBuffer

プリンターに送信されるコード フラグメントを含むバッファーへの呼び出し元指定のポインター。

cbSize

pBuffer が指すバッファー内の呼び出し元から指定されたバイト数。

dwWait

現在のジョブが中止された後に新しい印刷ジョブを開始するまでに、プリンターが待機する必要がある呼び出し元が指定した時間 (ミリ秒単位)。

戻り値

メソッドは、次のいずれかの値を返す必要があります。

リターン コード 説明
S_OK
 操作が成功しました。
E_FAIL
 操作が失敗しました。
E_NOTIMPL
 このメソッドは実装されていません。

注釈

OEM は 、IPrintOemDriverUni::D rvWriteSpoolBuf を使用してプリンターに出力を送信します。 印刷ジョブがユーザーによって終了された場合、 IPrintOemDriverUni::DrvWriteSpoolBuf E_FAILを返し、プリンターにデータを送信するために使用できなくなります。 この場合、特定のプリンターは、新しい印刷ジョブを開始する前に状態をリセットして、クリーンアップ コード フラグメントを送信する必要があります。 これらのプリンターでは、 を使用して、 IPrintOemDriverUni::DrvWritetAbortBuf このコード フラグメントをプリンターに送信します。

IPrintOemDriverUni::DrvWriteAbortBuf は、E_FAILが返された後 IPrintOemDriverUni::DrvWriteSpoolBuf にのみ呼び出すことができます。 IPrintOemDriverUni::DrvWriteAbortBuf は、ジョブごとに複数回呼び出さないでください。

レンダリング プラグインについては、「 Microsoft のプリンター ドライバーのカスタマイズ」を参照してください。

要件

要件 値
対象プラットフォーム デスクトップ
Header prcomoem.h (Prcomoem.h を含む)