PFAXPRINTCOVERPAGEW

コールバック

シグネチャ

BOOL PFAXPRINTCOVERPAGEW(
    FAX_CONTEXT_INFOW* FaxContextInfo,
    FAX_COVERPAGE_INFOW* CoverPageInfo
);

パラメーター

フィールド	型	説明
FaxContextInfo	FAX_CONTEXT_INFOW*	FAX プリンターのデバイスコンテキストへのハンドルを格納する FAX_CONTEXT_INFO 構造体へのポインターです。
CoverPageInfo	FAX_COVERPAGE_INFOW*	FAX ドキュメントのカバーページに表示する個人情報を格納する FAX_COVERPAGE_INFO 構造体へのポインターです。

公式ドキュメント

FaxPrintCoverPage 関数は、FAX クライアントアプリケーションのために、指定されたデバイスコンテキストに FAX 送信のカバーページを印刷します。

戻り値

型: BOOL

関数が成功すると、戻り値は 0 以外の値になります。

関数が失敗すると、戻り値は 0 になります。拡張エラー情報を取得するには、GetLastError を呼び出します。GetLastError は次のいずれかのエラーを返すことがあります。

戻り値	説明
ERROR_INVALID_PARAMETER	CoverPageInfo または FaxContextInfo パラメーターの一方または両方が NULL です。
ERROR_INVALID_PARAMETER	指定された FAX_COVERPAGE_INFO 構造体の SizeOfStruct メンバーが sizeof(FAX_COVERPAGE_INFO) と等しくありません。または、指定された FAX_CONTEXT_INFO 構造体の SizeOfStruct メンバーが sizeof(FAX_CONTEXT_INFO) と等しくありません。
ERROR_FILE_NOT_FOUND	FAX サーバーが、FAX_COVERPAGE_INFO 構造体の CoverPageName メンバーで指定されたファイルを見つけられません。

解説(Remarks)

デバイスコンテキストのハンドルは、FaxStartPrintJob 関数を使用して取得します。

カバーページには、ローカルコンピューターに保存されている個人用カバーページ、または FAX サーバーに保存されている共通のカバーページを使用できます。

Note アプリケーションは、印刷ジョブを完了するために AbortDoc 関数または EndDoc 関数も呼び出し、さらにプリンターのデバイスコンテキストへのハンドルを解放するために DeleteDC 関数を呼び出す必要があります。詳細については、「Printing a Fax to a Device Context」を参照してください。

FAX クライアントアプリケーションは、FAX ジョブと共にカバーページを印刷するために、FaxPrintCoverPage 関数を呼び出す前に FaxStartPrintJob 関数を呼び出す必要があります。詳細については、「Cover Pages」および「Printing a Fax to a Device Context」を参照してください。

メモ

winfax.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして FaxPrintCoverPage を定義しています。エンコーディング中立のエイリアスと、エンコーディング中立でないコードを混在させると、不一致が生じてコンパイルエラーや実行時エラーの原因となることがあります。詳細については、Conventions for Function Prototypes を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)