StartDocA 関数 (wingdi.h)

StartDoc 関数は、印刷ジョブを開始します。

構文

int StartDocA(
  [in] HDC            hdc,
  [in] const DOCINFOA *lpdi
);

パラメーター

[in] hdc

印刷ジョブのデバイス コンテキストへのハンドル。

[in] lpdi

ドキュメント ファイルの名前と出力ファイルの名前を含む DOCINFO 構造体へのポインター。

戻り値

関数が成功した場合、戻り値は 0 より大きくなります。 この値は、ドキュメントの印刷ジョブ識別子です。

関数が失敗した場合、戻り値は 0 以下になります。

解説

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

 

アプリケーションは、印刷ジョブを開始する直前に StartDoc 関数を呼び出す必要があります。 この関数を使用すると、複数ページのドキュメントが他の印刷ジョブと散在しないようにします。

アプリケーションでは、 StartDoc によって返される値を使用して、印刷ジョブの優先順位を取得または設定できます。 GetJob 関数または SetJob 関数を呼び出し、この値を必要な引数の 1 つとして指定します。

例

この関数を使用するサンプル プログラムについては、「 方法: GDI Print API を使用して印刷する」を参照してください。

Note

wingdi.h ヘッダーは、StartDoc をエイリアスとして定義します。このエイリアスは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択します。 encoding-neutral エイリアスの使用を encoding-neutral ではないコードと混在すると、コンパイル エラーまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。

要件

サポートされている最小のクライアント	Windows 2000 Professional [デスクトップ アプリのみ]
サポートされている最小のサーバー	Windows 2000 Server [デスクトップ アプリのみ]
対象プラットフォーム	Windows
ヘッダー	wingdi.h (Windows.h を含む)
Library	Gdi32.lib
[DLL]	Gdi32.dll

関連項目

DOCINFO

EndDoc

GetJob

印刷スプーラー API 関数

印刷

SetJob