Win32 API 日本語リファレンス
ホーム › Devices.Fax › PFAXGETPAGEDATA

PFAXGETPAGEDATA

コールバック

シグネチャ

BOOL PFAXGETPAGEDATA(
    HANDLE FaxHandle,
    DWORD JobId,
    BYTE** Buffer,
    DWORD* BufferSize,
    DWORD* ImageWidth,
    DWORD* ImageHeight
);

パラメーター

フィールド型説明
FaxHandleHANDLEFaxConnectFaxServer 関数の呼び出しによって返されたファクスサーバーのハンドルを指定します。
JobIdDWORDデータのページに関連付けられたファクスジョブを識別する一意の番号を指定します。
BufferBYTE**ファクスドキュメントの最初のページのデータを受け取るバッファーのアドレスへのポインター。メモリの割り当てについては、後述の「解説」セクションを参照してください。
BufferSizeDWORD*Buffer パラメーターが指すバッファーのサイズ (バイト単位) を受け取る DWORD 変数へのポインター。
ImageWidthDWORD*ファクスイメージの幅 (ピクセル単位) を受け取る DWORD 変数へのポインター。
ImageHeightDWORD*ファクスイメージの高さ (ピクセル単位) を受け取る DWORD 変数へのポインター。

公式ドキュメント

FaxGetPageData 関数は、ファクスジョブの最初のページのデータをファクスクライアントアプリケーションに返します。ファクスジョブは送信ジョブである必要がありますが、キューに格納されているジョブでもアクティブなジョブでもかまいません。この関数は、Tagged Image File Format Class F (TIFF Class F) 形式でデータを返します。

戻り値

Type: BOOL

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

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

戻り値 説明
ERROR_ACCESS_DENIED
 アクセスが拒否されました。FAX_JOB_QUERY アクセス権が必要です。
ERROR_INVALID_PARAMETER
 Buffer、BufferSize、ImageWidth、ImageHeight、FaxHandle の各パラメーターのいずれか、またはすべてが NULL です。
ERROR_NOT_ENOUGH_MEMORY
 メモリの割り当て中にエラーが発生しました。
ERROR_INVALID_DATA
 無効なデータによるエラーが発生しました。たとえば、JobId パラメーターで識別されるファクスジョブが送信ファクスではない場合です。ジョブは JT_SEND ジョブタイプで指定する必要があります。

解説(Remarks)

ファクスクライアントアプリケーションは、管理目的で FaxGetPageData 関数を呼び出し、ファクスキュー内のファクスドキュメントのサムネイルを表示できます。

ファクスサービスは、Tagged Image File Format (TIFF) 6.0 仕様に基づく TIFF Class F ファイルとしてファクスドキュメントを作成します。FaxGetPageData 関数は、Modified Modified READ (MMR) 二次元符号化によるデータ圧縮形式の TIFF データストリームを返します。呼び出し元のアプリケーションは、このデータストリームをデコードする必要があります。詳細については、Fax Image Format を参照してください。

FaxGetPageData 関数は、Buffer パラメーターに必要なメモリを割り当てます。アプリケーションは、このパラメーターに関連付けられたリソースを解放するために FaxFreeBuffer 関数を呼び出す必要があります。

詳細については、Displaying Documents in the Fax Job Queue および Freeing Fax Resources を参照してください。

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