PFAXSTARTPRINTJOBA
コールバックシグネチャ
BOOL PFAXSTARTPRINTJOBA(
LPSTR PrinterName,
FAX_PRINT_INFOA* PrintInfo,
DWORD* FaxJobId,
FAX_CONTEXT_INFOA* FaxContextInfo
);パラメーター
| フィールド | 型 | 説明 |
|---|---|---|
| PrinterName | LPSTR | ファックス プリンターの名前を格納した、定数の null 終端文字列へのポインターです。この文字列には次のいずれかを指定できます。
|
| PrintInfo | FAX_PRINT_INFOA* | ファックス送信を印刷するためにファックス サーバーが必要とする情報を格納した FAX_PRINT_INFO 構造体へのポインターです。この構造体には、受信者のファックス番号、送信者と受信者のデータ、省略可能な課金コード、配信レポート情報などが含まれます。詳細については、後述の「解説」セクションを参照してください。 |
| FaxJobId | DWORD* | ファックス印刷ジョブに対する印刷スプーラーの一意な ID を受け取る DWORD 変数へのポインターです。(これはファックス キューにおけるジョブの ID とは異なり、ファックス ID を引数に取るファックス API のパラメーターとして使用することはできません。) このパラメーターは必須です。 |
| FaxContextInfo | FAX_CONTEXT_INFOA* | プリンター デバイス コンテキストのハンドルを受け取る FAX_CONTEXT_INFO 構造体へのポインターです。ファックス クライアント アプリケーションは FaxPrintCoverPage 関数を呼び出すとき、この値をその関数の FaxContextInfo パラメーターに渡す必要があります。詳細については、デバイス コンテキストおよび印刷と印刷スプーラーのリファレンスを参照してください。 |
公式ドキュメント
ファックス クライアント アプリケーションは、指定したファックス プリンターで送信ファックスの印刷を開始するために FaxStartPrintJob 関数を呼び出します。
戻り値
型: BOOL
関数が成功すると、0 以外の値を返します。
関数が失敗すると、0 を返します。拡張エラー情報を取得するには、GetLastError を呼び出します。GetLastError は次のいずれかのエラーを返すことがあります。
| 戻り値 | 説明 |
|---|---|
| PrintInfo または FaxContextInfo パラメーターの一方、または両方が NULL です。 | |
| FAX_PRINT_INFO 構造体の RecipientNumber メンバーが NULL です。または、OutputFileName メンバーが NULL で、かつ RecipientNumber メンバーが指定されていません。 | |
| PrinterName パラメーターに、ファックス プリンターではないプリンターが指定されているか、ファックス プリンターがインストールされていません。 | |
| メモリの割り当て中にエラーが発生しました。 | |
|
FaxStartPrintJob が先に呼び出されていないため、StartDoc の呼び出しが行われていません。 |
解説(Remarks)
この関数はデバイス コンテキストのハンドルを返します。このハンドルは、FaxPrintCoverPage 関数のほか、AbortDoc、EndDoc、DeleteDC、StartPage、EndPage などの Win32 Windows Graphics Device Interface (GDI) 関数で使用されます。
この変更により、ユーザーから情報を収集するファックス送信ウィザードが表示されなくなります。ファックス サーバーは、PrintInfo パラメーターが指す FAX_PRINT_INFO 構造体のデータを使用してファックス送信を印刷します。この構造体には、ファックス送信ウィザードが表示されていれば収集されたはずのデータが含まれます。
ファックス クライアント アプリケーションは、ファックス ジョブと共にカバー ページを印刷するために FaxPrintCoverPage 関数を呼び出す前に、FaxStartPrintJob 関数を呼び出す必要があります。
winfax.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版と Unicode 版を自動的に選択するエイリアスとして FaxStartPrintJob を定義しています。エンコード ニュートラルなエイリアスの使用と、エンコード ニュートラルではないコードを混在させると、不一致が生じてコンパイル エラーや実行時エラーの原因となることがあります。詳細については、関数プロトタイプの規則を参照してください。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)