PFAXGETJOBA

コールバック

シグネチャ

BOOL PFAXGETJOBA(
    HANDLE FaxHandle,
    DWORD JobId,
    FAX_JOB_ENTRYA** JobEntry
);

パラメーター

フィールド	型	説明
FaxHandle	HANDLE	FaxConnectFaxServer 関数の呼び出しによって返されたファックスサーバーのハンドルを指定します。
JobId	DWORD	キュー内のジョブまたは実行中のファックスジョブを識別する一意の番号を指定します。ジョブは、受信側の送信でも送信側の送信でもかまいません。
JobEntry	FAX_JOB_ENTRYA**	FAX_JOB_ENTRY 構造体を受け取るバッファーのアドレスへのポインターです。このデータには、ジョブの種類と状態、受信者と送信者の識別情報、スケジュールと配信の設定、およびページ数が含まれます。メモリの割り当てについては、後述の「解説」セクションを参照してください。

公式ドキュメント

ファックスクライアントアプリケーションは、指定されたキュー内のジョブまたは実行中のファックスジョブの詳細情報を取得するために FaxGetJob 関数を呼び出します。この関数は、情報を FAX_JOB_ENTRY 構造体で返します。

戻り値

型: BOOL

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

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

戻り値	説明
ERROR_ACCESS_DENIED	アクセスが拒否されました。FAX_JOB_QUERY アクセス権が必要です。
ERROR_INVALID_PARAMETER	JobId パラメーターが無効であるか、JobEntry または FaxHandle パラメーターの一方または両方が NULL です。
ERROR_NOT_ENOUGH_MEMORY	メモリの割り当て中にエラーが発生しました。

解説(Remarks)

FaxGetJob 関数は、個々のファックスジョブに関する情報を取得します。対象のファックスサーバー上でキューに入っているジョブと実行中のジョブすべての情報を取得するには、FaxEnumJobs 関数を呼び出します。

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

詳細については、Managing Fax Jobs および Freeing Fax Resources を参照してください。

メモ

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

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