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

IFaxOutgoingMessage2

COMIDispatch (デュアル)
📘 Microsoft Learn (日本語) · English
✅ IDispatch を実装(デュアルインターフェース)。HSP では comobj 経由でメソッド名による遅延バインド呼び出しができます(vtableインデックス不要)。
IIDb37df687-bc88-4b46-b3be-b458b3ea9e7f継承元IFaxOutgoingMessage呼び出し名前(IDispatch) または vtbl自前メソッド開始 vtbl26

公式ドキュメント

FAX クライアント アプリケーションが、送信済み FAX のアーカイブ内にある送信メッセージの情報を取得するために使用します。

解説(Remarks)

C++ で FaxIncomingMessage2 オブジェクトを作成するには、IFaxAccountOutgoingArchive::GetMessage メソッドまたは Message メソッドを呼び出します。

このインターフェイスの既定の実装は、Windows Vista 以降では FaxOutgoingMessage オブジェクトによって提供されます。Windows XP 以前では、FaxOutgoingMessage オブジェクトが IFaxAccountOutgoingArchive インターフェイスを実装します。

メソッド 7

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

vtbl 26 HRESULT get_HasCoverPage(VARIANT_BOOL* pbHasCoverPage)

FAX にカバー ページがあるかどうかを示します。

pbHasCoverPageVARIANT_BOOL*out送信メッセージがカバーページを含むかを受け取るVARIANT_BOOLポインタ。
vtbl 27 HRESULT get_ReceiptType(FAX_RECEIPT_TYPE_ENUM* pReceiptType)

送信の試行後に送信される配信レポートの種類を指定します。

pReceiptTypeFAX_RECEIPT_TYPE_ENUM*out送達通知の方式を表すFAX_RECEIPT_TYPE_ENUM値を受け取るポインタ。メール通知等を示す。
vtbl 28 HRESULT get_ReceiptAddress(LPWSTR* pbstrReceiptAddress)

配信レポートの送信先アドレスを指定します。

pbstrReceiptAddressLPWSTR*out送達通知の送付先アドレスを受け取るBSTRポインタ。

解説(Remarks)

アドレスの種類は、次の表に示すように IFaxOutgoingMessage2::ReceiptType プロパティの値に応じて異なります。

IFaxOutgoingMessage2::ReceiptType プロパティの値 アドレスの種類
frtMAIL SMTP の電子メール アドレス
frtMSGBOX 配信レポートのメッセージ ボックスを表示するコンピューター名
vtbl 29 HRESULT get_Read(VARIANT_BOOL* pbRead)

FAX が既読かどうかを示します。(Get)

pbReadVARIANT_BOOL*out送信メッセージが既読としてマークされているかを受け取るVARIANT_BOOLポインタ。

解説(Remarks)

指定できる値は VARIANT_TRUE と VARIANT_FALSE です。

この値への変更は、IFaxOutgoingMessage2::Save が呼び出されるまでサーバーに反映されません。

vtbl 30 HRESULT put_Read(VARIANT_BOOL bRead)

FAX が既読かどうかを示します。(Put)

bReadVARIANT_BOOLin送信メッセージの既読/未読状態を設定するVARIANT_BOOL。VARIANT_TRUEで既読。

解説(Remarks)

指定できる値は VARIANT_TRUE と VARIANT_FALSE です。

この値への変更は、IFaxOutgoingMessage2::Save が呼び出されるまでサーバーに反映されません。

vtbl 31 HRESULT Save()

FaxOutgoingMessage オブジェクトのデータを保存します。

戻り値

型: HRESULT

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

解説(Remarks)

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

vtbl 32 HRESULT Refresh()

FAX サーバーから FaxOutgoingMessage オブジェクトの情報を最新の状態に更新します。Refresh メソッドを呼び出すと、最後に Save メソッドを呼び出した後に行った構成の変更は失われます。

戻り値

型: HRESULT

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

解説(Remarks)

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IFaxOutgoingMessage2 "{B37DF687-BC88-4B46-B3BE-B458B3EA9E7F}"
#usecom global IFaxOutgoingMessage2 IID_IFaxOutgoingMessage2 "{}"
#comfunc global IFaxOutgoingMessage2_get_HasCoverPage    26 var
#comfunc global IFaxOutgoingMessage2_get_ReceiptType     27 var
#comfunc global IFaxOutgoingMessage2_get_ReceiptAddress  28 var
#comfunc global IFaxOutgoingMessage2_get_Read            29 var
#comfunc global IFaxOutgoingMessage2_put_Read            30 int
#comfunc global IFaxOutgoingMessage2_Save                31
#comfunc global IFaxOutgoingMessage2_Refresh             32
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。