PFAXENUMJOBSA

コールバック

シグネチャ

BOOL PFAXENUMJOBSA(
    HANDLE FaxHandle,
    FAX_JOB_ENTRYA** JobEntry,
    DWORD* JobsReturned
);

パラメーター

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

公式ドキュメント

FaxEnumJobs 関数は、クライアントが接続しているファックスサーバー上の、キューに入っているすべてのファックスジョブとアクティブなファックスジョブを列挙します。この関数は、各ファックスジョブの詳細情報をファックスクライアントアプリケーションに返します。

戻り値

型: BOOL

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

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

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

解説(Remarks)

FaxEnumJobs 関数は、対象のファックスサーバー上のファックスジョブの一覧と、各ジョブについて取得できる情報を返します。ファックス管理アプリケーションは通常、管理または照会の目的でファックスジョブキューを表示するためにこの関数を呼び出します。詳細については、Managing Fax Jobs を参照してください。

FaxEnumJobs 関数は、JobEntry パラメーターが指す FAX_JOB_ENTRY バッファー配列に必要なメモリを割り当てます。アプリケーションは、このパラメーターに関連付けられたリソースを解放するために FaxFreeBuffer 関数を呼び出す必要があります。詳細については、Freeing Fax Resources を参照してください。

メモ

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

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