ScheduleJob 関数

  • [アーティクル]

ScheduleJob 関数は、印刷スプーラーが印刷のために指定された印刷ジョブをスケジュールするように要求します。

構文

BOOL ScheduleJob(
  _In_ HANDLE hPrinter,
  _In_ DWORD  dwJobID
);

パラメーター

hPrinter [in]

印刷ジョブのプリンターへのハンドル。 これは、スプール・プリンターとして構成されているローカル・プリンターでなければなりません。 hPrinter がリモート プリンター接続へのハンドルである場合、またはプリンターが直接印刷用に構成されている場合、ScheduleJob 関数は失敗します。 プリンター ハンドルを取得するには、 OpenPrinter 関数または AddPrinter 関数を使用します。

hPrinter は、dwJobID 印刷ジョブ ID を取得した AddJob の呼び出しで指定されたのと同じプリンター ハンドルである必要があります。

dwJobID [in]

スケジュールする印刷ジョブ。 この印刷ジョブ識別子を取得するには、 AddJob 関数を呼び出します。

戻り値

関数が成功した場合、戻り値は 0 以外の値になります。

関数が失敗した場合は、0 を返します。

解説

Note

これはブロック関数または同期関数であり、すぐには返されない場合があります。 この関数が返す速度は、アプリケーションの作成時に予測が困難なネットワーク状態、プリント サーバーの構成、プリンター ドライバーの実装要因などの実行時の要因によって異なります。 ユーザー インターフェイスとの対話を管理するスレッドからこの関数を呼び出すと、アプリケーションが応答しなくなる可能性があります。

ScheduleJob 関数を呼び出す前に、AddJob 関数を正常に呼び出す必要があります。 AddJob は、 ScheduleJob に渡す印刷ジョブ識別子を dwJobID として取得します。 どちらの呼び出しも hPrinter に同じ値を使用する必要があります。

ScheduleJob 関数は、有効なスプール・ファイルを検査します。 無効なスプール・ファイルがある場合、またはそれが空の場合、 ScheduleJob はスプール・ファイルと印刷スプーラー内の対応する印刷ジョブ項目の両方を削除します。

必要条件

要件 値
サポートされている最小のクライアント
 Windows 2000 Professional [デスクトップ アプリのみ]
サポートされている最小のサーバー
 Windows 2000 Server [デスクトップ アプリのみ]
ヘッダー
Winspool.h (Windows.h を含む)
ライブラリ
Winspool.lib
[DLL]
Spoolss.dll

関連項目

印刷

印刷スプーラー API 関数

AddJob

OpenPrinter