ホーム › Devices.Fax › IFaxDocument2

IFaxDocument2

COMIDispatch (デュアル)

📘 Microsoft Learn (日本語) · English

✅ IDispatch を実装(デュアルインターフェース)。HSP では comobj 経由でメソッド名による遅延バインド呼び出しができます(vtableインデックス不要)。

IIDe1347661-f9ef-4d6d-b4a5-c0a068b65cff継承元IFaxDocument呼び出し名前(IDispatch) または vtbl自前メソッド開始 vtbl41

公式ドキュメント

FAX クライアントアプリケーションが FAX ドキュメントを作成し、処理のために FAX サービスへ送信するために使用するメッセージングオブジェクトを定義します。

解説(Remarks)

IFaxDocument および IFaxDocument2 の既定の実装は、FaxDocument オブジェクトとして提供されます。

メソッド 5

vtbl = vtable インデックス(0始まり)。IDispatch 実装のため HSP ではメソッド名でも呼べます(上記)。低レベルの index 呼び出し用に vtbl も掲載。0〜2 は IUnknown。

vtbl 41 HRESULT get_SubmissionId(LPWSTR* pbstrSubmissionId)

FAX ドキュメントの送信識別子 (submission identifier) を取得します。

pbstrSubmissionId

LPWSTR*

out

送信したファクスドキュメントのサブミッションIDを受け取るBSTRポインタ。

解説(Remarks)

このプロパティは、FAX を送信するメソッドが完了するたびに設定されます。

vtbl 42 HRESULT get_Bodies(VARIANT* pvBodies)

1 つ以上のドキュメントのコレクションを FAX ドキュメントに提供します。(Get)

pvBodies

VARIANT*

out

送信本文ファイルのパス配列を格納したVARIANTを受け取るポインタ。複数本文に対応する。

解説(Remarks)

FAX 本文として送信できるドキュメントの例には、テキストファイル (.txt)、Microsoft Word ドキュメント (.doc)、Microsoft Excel スプレッドシート (.xls) などがあります。ファイル名はセミコロン ";" で区切ります。たとえば、"myfile.txt;anotherfile.doc" のように指定します。

IFaxDocument2::Bodies プロパティと Body プロパティのいずれか一方は NULL でなければなりません。IFaxDocument2::ConnectedSubmit2 または IFaxDocument2::Submit2 (いずれも Windows Vista 以降でのみ使用可能) を使用して送信する場合は、IFaxDocument2::Bodies を使用する必要があります。ConnectedSubmit または Submit を使用して送信する場合は、Body を使用する必要があります。

vtbl 43 HRESULT put_Bodies(VARIANT vBodies)

1 つ以上のドキュメントのコレクションを FAX ドキュメントに提供します。(Put)

vBodies

VARIANT

送信本文ファイルのパス配列(またはSAFEARRAY)を格納したVARIANT。複数本文を指定できる。

解説(Remarks)

vtbl 44 HRESULT Submit2(LPWSTR bstrFaxServerName, VARIANT* pvFaxOutgoingJobIDs, INT* plErrorBodyFile)

1 つ以上のドキュメントを処理のために FAX サービスへ送信します。注: このメソッドは Windows Vista 以降でのみサポートされます。

bstrFaxServerName	LPWSTR	in	FAX サーバーを指定する BSTR です。このパラメーターが NULL または空文字列の場合、ローカルの FAX サーバーが指定されます。
pvFaxOutgoingJobIDs	VARIANT*	out	FAX の受信者ごとに 1 つずつ、送信ジョブ ID のコレクションを指定する VARIANT です。
plErrorBodyFile	INT*	out	FAX 送信操作の失敗の原因となった送信ファイルの、0 から始まる位置を表す LONG です。「解説」を参照してください。

戻り値

型: HRESULT

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

解説(Remarks)

IFaxDocument2::Submit2 を呼び出す前に、FAX 送信するファイルをセミコロン区切りで列挙したリストを IFaxDocument2::Bodies プロパティに設定する必要があります。

注 IFaxDocument2::Submit2 を使用するには、Body プロパティが NULL である必要があります。

ドキュメントを送信する際にはサーバー名を指定する必要があります。ローカルサーバーへドキュメントを送信するには、bstrFaxServerName パラメーターに NULL または空文字列を設定します。このメソッドは、FAX の受信者ごとに 1 つずつ、FAX ジョブ ID のコレクションを返します。

IFaxDocument2::Submit2 メソッドが成功するには、FAX に少なくとも 1 人の受信者と、カバーページまたは FAX 本文のいずれかが必要です。このメソッドは、サーバー (リモートまたはローカル) がローカルコンピューターにネットワークプリンターとしてインストールされている場合にのみ使用できます。

このメソッドは、Windows XP Home Edition または Windows XP Professional で動作する FAX サーバーへのリモート接続ではサポートされておらず、エラー FAX_E_NOT_SUPPORTED_ON_THIS_SKU を返します。

このメソッドを使用するには、FAX ドキュメントの Priority に応じて、ユーザーに far2SUBMIT_LOW、far2SUBMIT_NORMAL、または far2SUBMIT_HIGH のアクセス権が正しく設定されている必要があります。

plErrorBodyFile の例として、次のケースを考えます。IFaxDocument2::Bodies の値として、次のファイル一覧が送信されたとします。

"MyTextFile.txt;AnotherTextFile.txt;MyPDFfile.pdf;MyWordFile.doc"

"*.pdf" 拡張子はサポートされていないため送信操作は失敗し、plErrorBodyFile は 2 を返します。

vtbl 45 HRESULT ConnectedSubmit2(IFaxServer* pFaxServer, VARIANT* pvFaxOutgoingJobIDs, INT* plErrorBodyFile)

1 つ以上の FAX ドキュメントを、接続済みの FaxServer へ送信します。

pFaxServer	IFaxServer*	inoptional	接続済みの FAX サーバーを指定する FaxServer オブジェクトです。
pvFaxOutgoingJobIDs	VARIANT*	out	FAX の受信者ごとに 1 つずつ、送信ジョブ ID 文字列の配列を保持する VARIANT です。
plErrorBodyFile	INT*	out	FAX 送信操作の失敗の原因となった送信ファイルの、0 から始まる位置を表す LONG です。「解説」を参照してください。

戻り値

型: HRESULT

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

解説(Remarks)

注 IFaxDocument2::ConnectedSubmit2 メソッドが成功するには、FAX に少なくとも 1 人の受信者と、カバーページまたは FAX 本文のいずれかが必要です。このメソッドは、サーバー (リモートまたはローカル) がローカルコンピューターにネットワークプリンターとしてインストールされている場合にのみ使用できます。

IFaxDocument2::ConnectedSubmit2 を呼び出す前に、FAX 送信するファイルをセミコロン区切りで列挙したリストを IFaxDocument2::Bodies プロパティに設定する必要があります。

注 IFaxDocument2::ConnectedSubmit2 を使用するには、Body プロパティが NULL である必要があります。

このメソッドは、Windows XP Home Edition または Windows XP Professional で動作する FAX サーバーへのリモート接続ではサポートされておらず、次のエラーを返します: FAX_E_NOT_SUPPORTED_ON_THIS_SKU。

plErrorBodyFile を説明する例を次に示します。IFaxDocument2::Bodies の値として、次のファイル一覧が送信されたとします。

"MyTextFile.txt;AnotherTextFile.txt;MyPDFfile.pdf;MyWordFile.doc"

"*.pdf" 拡張子はサポートされていないため送信操作は失敗し、plErrorBodyFile は 2 を返します。

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

HSP用 COM定義

#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。

出力引数:

#define global IID_IFaxDocument2 "{E1347661-F9EF-4D6D-B4A5-C0A068B65CFF}"
#usecom global IFaxDocument2 IID_IFaxDocument2 "{0F3F9F91-C838-415E-A4F3-3E828CA445E0}"
#comfunc global IFaxDocument2_get_SubmissionId  41 var
#comfunc global IFaxDocument2_get_Bodies        42 var
#comfunc global IFaxDocument2_put_Bodies        43 int
#comfunc global IFaxDocument2_Submit2           44 wstr,var,var
#comfunc global IFaxDocument2_ConnectedSubmit2  45 sptr,var,var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※#usecom 末尾は CoCreateInstance 用のクラスID(コクラスCLSID, SDKから自動取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。#define global IID_IFaxDocument2 "{E1347661-F9EF-4D6D-B4A5-C0A068B65CFF}"
#usecom global IFaxDocument2 IID_IFaxDocument2 "{0F3F9F91-C838-415E-A4F3-3E828CA445E0}"
#comfunc global IFaxDocument2_get_SubmissionId  41 sptr
#comfunc global IFaxDocument2_get_Bodies        42 sptr
#comfunc global IFaxDocument2_put_Bodies        43 int
#comfunc global IFaxDocument2_Submit2           44 wstr,sptr,sptr
#comfunc global IFaxDocument2_ConnectedSubmit2  45 sptr,sptr,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※#usecom 末尾は CoCreateInstance 用のクラスID(コクラスCLSID, SDKから自動取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。