IFaxOutgoingJob

IFaxOutgoingJob インターフェースは、FAX クライアント アプリケーションが FAX サーバーのキュー内にある送信 FAX ジョブに関する情報を取得するために使用するオブジェクトを表します。

IFaxOutgoingJob の既定の実装は、FaxOutgoingJob オブジェクトとして提供されます。

IFaxOutgoingJob::get_Subject プロパティは、FAX のカバー ページの件名フィールドの内容を格納する NULL 終端文字列です。

IFaxOutgoingJob::get_DocumentName プロパティは、FAX ドキュメントの表示に使用する分かりやすい名前を格納する NULL 終端文字列です。

IFaxOutgoingJob::get_Pages プロパティは、送信 FAX ジョブの総ページ数を示す数値です。

IFaxOutgoingJob::get_Size プロパティは、送信 FAX ジョブに関連付けられた Tagged Image File Format Class F (TIFF Class F) ファイルのサイズを示す値です。

IFaxOutgoingJob::get_SubmissionId プロパティは、送信処理中に FAX ジョブへ割り当てられた一意の識別子を格納する NULL 終端文字列です。

同じ送信処理によって作成されたすべての FAX ジョブは、同一の一意な送信 ID を共有します。複数の受信者宛てに FAX を送信する場合、個別の FAX ジョブが作成されますが、それらは同一の FAX ブロードキャストの一部であるため、同じ SubmissionID を共有します。

IFaxOutgoingJob::get_Id プロパティは、送信 FAX ジョブの一意の識別子を格納する NULL 終端文字列です。この識別子を使用すると、ジョブが正常に完了した後にアーカイブされた FAX メッセージを取得できます。

IFaxOutgoingJob::get_OriginalScheduledTime プロパティは、FAX ジョブが最初に送信予定として設定された時刻を指定します。

IFaxOutgoingJob::get_SubmissionTime プロパティは、送信 FAX ジョブが処理のために送信された時刻を示します。

IFaxOutgoingJob::get_ReceiptType プロパティは、FAX メッセージが最終状態に達したときに配信する配信確認 (レシート) の種類を指定する値です。レシートの種類には、Simple Mail Transport Protocol (SMTP) メール、メッセージ ボックス、またはレシートなしを指定できます。

IFaxOutgoingJob::get_Priority プロパティは、FAX の送信時に使用する優先度 (たとえば、通常、低、高の優先度) を指定します。

IFaxOutgoingJob::get_Sender プロパティは、FAX の送信者に関する情報を格納するオブジェクトを取得します。

IFaxOutgoingJob::get_Recipient プロパティは、FAX ジョブの受信者に関する情報を格納するオブジェクトへのインターフェースを取得します。

IFaxOutgoingJob::get_CurrentPage プロパティは、FAX サービスが送信 FAX ジョブで現在送信中のページを識別する数値です。

IFaxOutgoingJob::get_DeviceId プロパティは、送信 FAX ジョブを送信しているデバイスのデバイス ID を示します。

IFaxOutgoingJob::get_Status プロパティは、ジョブ キュー内の送信 FAX ジョブの現在の状態を示す数値です。

詳細については、FAX_JOB_STATUS_ENUM を参照してください。

IFaxOutgoingJob::get_ExtendedStatusCode プロパティは、ジョブの拡張状態を表すコードを指定します。

FAX サービス プロバイダー (FSP) が独自の状態コードを提供する場合、サービスは FSP からコード文字列を読み込み、その文字列と元の状態コードの両方をクライアントに渡します。FSP が FAX_JOB_EXTENDED_STATUS_ENUM で定義された状態を提供する場合、サービスは状態コードのみをクライアントに渡します。

FAX クライアント アプリケーションは、まず拡張状態文字列を確認する必要があります。文字列が NULL/空でない場合、その文字列が拡張状態を表しており、拡張状態コードは FSP が FAX サービスに渡したコードと同じです。文字列が NULL/空の場合、拡張状態コードは FAX_JOB_EXTENDED_STATUS_ENUM で定義されているコードのいずれかです。

IFaxOutgoingJob::get_ExtendedStatus プロパティは、ジョブの拡張状態を説明する NULL 終端文字列です。

IFaxOutgoingJob::get_ExtendedStatus プロパティが値を持つのは、FAX サービス プロバイダー (FSP) が IFaxOutgoingJob::get_ExtendedStatusCode プロパティで独自の状態コードを返す場合のみです。それ以外の場合、IFaxOutgoingJob::get_ExtendedStatus プロパティには空の文字列が格納されます。同様に、FSP は IFaxOutgoingJob::get_ExtendedStatus プロパティの値を提供しないことを選択できます。その場合も、このプロパティには空の文字列が格納されます。FAX サービスに付属する T.30 FSP はこれに該当します。

FSP が独自の状態コードを提供する場合、サービスは FSP からコード文字列を読み込み、その文字列と元の状態コードの両方をクライアントに渡します。FSP が FAX_JOB_EXTENDED_STATUS_ENUM で定義された状態を提供する場合、サービスは状態コードのみをクライアントに渡します。

FAX クライアント アプリケーションは、まず拡張状態文字列を確認する必要があります。文字列が NULL/空でない場合、その文字列が拡張状態を表しており、拡張状態コードは FSP が FAX サービスに渡したコードと同じです。文字列が NULL/空の場合、拡張状態コードは FAX_JOB_EXTENDED_STATUS_ENUM で定義されているコードのいずれかです。

IFaxOutgoingJob::get_AvailableOperations プロパティは、現在の状態において FAX ジョブに対して実行できる有効な操作の組み合わせを示します。

IFaxOutgoingJob::get_Retries プロパティは、最初の送信試行が失敗した後に FAX サービスが送信 FAX の送信を試みた回数を示す値です。

IFaxOutgoingJob::get_ScheduledTime プロパティは、FAX を処理のために FAX サービスへ送信する時刻を示します。

IFaxOutgoingJob::get_TransmissionStart プロパティは、送信 FAX ジョブの送信が開始された時刻を示します。このプロパティが値を持つのは、送信が開始された後のみです。

FAX が失敗した場合、このプロパティには 0 が設定されます。失敗した FAX に対してこのプロパティを取得しようとすると、エラーが返されます。

IFaxOutgoingJob::get_TransmissionEnd プロパティは、送信 FAX ジョブの送信が完了した時刻を示します。

FAX デバイスによる FAX の送信が続いている間、このプロパティは有効ではありません。値を持つのは送信が終了した後のみです。個別の FAX の場合、送信が終了すると FAX は送信アーカイブへ移動されるため、この値を取得することはできません。代わりに、TransmissionEnd プロパティの値を取得できます。ブロードキャストの場合、ブロードキャスト全体が完了するまで各 FAX は送信キューに残るため、IFaxOutgoingJob::get_TransmissionEnd プロパティの値を取得できます。

FAX が失敗した場合、このプロパティには 0 が設定されます。失敗した FAX に対してこのプロパティを取得しようとすると、エラーが返されます。

IFaxOutgoingJob::get_CSID プロパティは、FAX 送信ジョブに関連付けられた着信局識別子 (CSID) を格納する NULL 終端文字列です。

IFaxOutgoingJob::get_TSID プロパティは、FAX 送信ジョブに関連付けられた送信局識別子 (TSID) を格納する NULL 終端文字列です。

IFaxOutgoingJob::get_GroupBroadcastReceipts プロパティは、ブロードキャストの受信者ごとに個別の配信確認を送信するか、すべての受信者に対する要約の配信確認を送信するかを示すブール値です。

ドキュメントに対して IFaxOutgoingJob::get_GroupBroadcastReceipts プロパティを設定するには、IFaxDocument::put_GroupBroadcastReceipts メソッドを使用します。

IFaxOutgoingJob::Pause メソッドは、送信 FAX ジョブを一時停止します。

型: HRESULT

このメソッドが成功すると S_OK を返します。それ以外の場合は HRESULT エラー コードを返します。

一時停止した FAX ジョブを再開するには、IFaxOutgoingJob::Resume メソッドを使用します。

このメソッドを使用するには、ユーザーが farSUBMIT_LOW または farMANAGE_JOBS のアクセス権を持っている必要があります。farSUBMIT_LOW アクセス権の場合、ユーザーは自分の FAX に対してのみこのメソッドを使用できます。farMANAGE_JOBS アクセス権の場合、ユーザーはサーバー上のすべての FAX に対してこのメソッドを使用できます。

IFaxOutgoingJob::Resume メソッドは、一時停止した送信 FAX ジョブを再開します。

型: HRESULT

このメソッドが成功すると S_OK を返します。それ以外の場合は HRESULT エラー コードを返します。

このメソッドを使用するには、ユーザーが farSUBMIT_LOW または farMANAGE_JOBS のアクセス権を持っている必要があります。farSUBMIT_LOW アクセス権の場合、ユーザーは自分の FAX に対してのみこのメソッドを使用できます。farMANAGE_JOBS アクセス権の場合、ユーザーはサーバー上のすべての FAX に対してこのメソッドを使用できます。

IFaxOutgoingJob::Restart メソッドは、失敗した送信 FAX ジョブを再開始します。たとえば、FAX ジョブが再試行回数を超えた場合、IFaxOutgoingJob::Restart によってその FAX ジョブを再開始できます。

型: HRESULT

このメソッドが成功すると S_OK を返します。それ以外の場合は HRESULT エラー コードを返します。

このメソッドを使用するには、ユーザーが farSUBMIT_LOW または farMANAGE_JOBS のアクセス権を持っている必要があります。farSUBMIT_LOW アクセス権の場合、ユーザーは自分の FAX に対してのみこのメソッドを使用できます。farMANAGE_JOBS アクセス権の場合、ユーザーはサーバー上のすべての FAX に対してこのメソッドを使用できます。

IFaxOutgoingJob::CopyTiff メソッドは、送信 FAX ジョブに関連付けられた Tagged Image File Format Class F (TIFF Class F) ファイルを、ローカル コンピューター上のファイルへコピーします。

型: HRESULT

このメソッドが成功すると S_OK を返します。それ以外の場合は HRESULT エラー コードを返します。

このメソッドを使用するには、ユーザーが farSUBMIT_LOW または farQUERY_JOBS のアクセス権を持っている必要があります。

farSUBMIT_LOW アクセス権の場合、ユーザーは自分の FAX に対してのみこのメソッドを使用できます。farQUERY_JOBS アクセス権の場合、ユーザーはサーバー上のすべての FAX に対してこのメソッドを使用できます。

Refresh メソッドは、FaxOutgoingJob オブジェクトの情報を FAX サーバーから最新の状態に更新します。

型: HRESULT

このメソッドが成功すると S_OK を返します。それ以外の場合は HRESULT エラー コードを返します。

このメソッドを使用するには、ユーザーが farSUBMIT_LOW または farQUERY_JOBS のアクセス権を持っている必要があります。

farSUBMIT_LOW アクセス権の場合、ユーザーは自分の FAX に対してのみこのメソッドを使用できます。farQUERY_JOBS アクセス権の場合、ユーザーはサーバー上のすべての FAX に対してこのメソッドを使用できます。

IFaxOutgoingJob::Cancel メソッドは、送信 FAX ジョブをキャンセルします。

型: HRESULT

このメソッドが成功すると S_OK を返します。それ以外の場合は HRESULT エラー コードを返します。

ブロードキャストの一部ではないジョブをキャンセルした場合、またはブロードキャスト全体をキャンセルした場合、Count プロパティは送信ジョブ数の変化を反映して更新されます。ただし、ブロードキャストから 1 件の FAX のみをキャンセルした場合、Count プロパティに変化は反映されません。キャンセルされた FAX は送信キューに残るため、ブロードキャストのすべての FAX の状態を確認できます。

このメソッドを使用するには、ユーザーが farSUBMIT_LOW または farMANAGE_JOBS のアクセス権を持っている必要があります。farSUBMIT_LOW アクセス権の場合、ユーザーは自分の FAX に対してのみこのメソッドを使用できます。farMANAGE_JOBS アクセス権の場合、ユーザーはサーバー上のすべての FAX に対してこのメソッドを使用できます。