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

IFaxIncomingMessage2

COMIDispatch (デュアル)
📘 Microsoft Learn (日本語) · English
✅ IDispatch を実装(デュアルインターフェース)。HSP では comobj 経由でメソッド名による遅延バインド呼び出しができます(vtableインデックス不要)。
IIDf9208503-e2bc-48f3-9ec0-e6236f9b509a継承元IFaxIncomingMessage呼び出し名前(IDispatch) または vtbl自前メソッド開始 vtbl20

公式ドキュメント

受信 FAX のアーカイブに保存されている受信済み FAX メッセージの情報を取得するために、FAX クライアント アプリケーションが使用します。(IFaxIncomingMessage2)

解説(Remarks)

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

このインターフェースの既定の実装は、FaxIncomingMessage オブジェクトによって提供されます。

メソッド 16

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

vtbl 20 HRESULT get_Subject(LPWSTR* pbstrSubject)

Subject プロパティは、受信 FAX メッセージに関連付けられた件名を格納します。このプロパティは null 終端文字列です。(Get)

pbstrSubjectLPWSTR*out受信メッセージの件名を受け取るBSTRポインタ。

解説(Remarks)

受信メッセージは、到着した時点では件名が null 値です。再割り当てされる際に、ルーティング アシスタントによって件名を設定できます。

vtbl 21 HRESULT put_Subject(LPWSTR bstrSubject)

Subject プロパティは、受信 FAX メッセージに関連付けられた件名を格納します。このプロパティは null 終端文字列です。(Put)

bstrSubjectLPWSTRin受信メッセージの件名を設定するBSTR。

解説(Remarks)

受信メッセージは、到着した時点では件名が null 値です。再割り当てされる際に、ルーティング アシスタントによって件名を設定できます。

vtbl 22 HRESULT get_SenderName(LPWSTR* pbstrSenderName)

受信 FAX メッセージに関連付けられた送信者の名前を格納します。このプロパティは null 終端文字列です。(Get)

pbstrSenderNameLPWSTR*out送信者名を受け取るBSTRポインタ。

解説(Remarks)

受信メッセージは、到着した時点では送信者が null 値です。再割り当てされる際に、ルーティング アシスタントによって送信者を指定できます。

vtbl 23 HRESULT put_SenderName(LPWSTR bstrSenderName)

受信 FAX メッセージに関連付けられた送信者の名前を格納します。このプロパティは null 終端文字列です。(Put)

bstrSenderNameLPWSTRin送信者名を設定するBSTR。

解説(Remarks)

受信メッセージは、到着した時点では送信者が null 値です。再割り当てされる際に、ルーティング アシスタントによって送信者を指定できます。

vtbl 24 HRESULT get_SenderFaxNumber(LPWSTR* pbstrSenderFaxNumber)

受信 FAX メッセージに関連付けられた送信者の FAX 番号を格納します。このプロパティは null 終端文字列です。(Get)

pbstrSenderFaxNumberLPWSTR*out送信者のファクス番号を受け取るBSTRポインタ。

解説(Remarks)

受信メッセージは、到着した時点では送信者の FAX 番号が null 値です。FAX が再割り当てされる際に、ルーティング アシスタントが送信者の FAX 番号を指定できます。

vtbl 25 HRESULT put_SenderFaxNumber(LPWSTR bstrSenderFaxNumber)

受信 FAX メッセージに関連付けられた送信者の FAX 番号を格納します。このプロパティは null 終端文字列です。(Put)

bstrSenderFaxNumberLPWSTRin送信者のファクス番号を設定するBSTR。

解説(Remarks)

受信メッセージは、到着した時点では送信者の FAX 番号が null 値です。FAX が再割り当てされる際に、ルーティング アシスタントが送信者の FAX 番号を指定できます。

vtbl 26 HRESULT get_HasCoverPage(VARIANT_BOOL* pbHasCoverPage)

FAX にカバー ページがあるかどうかを示すフラグです。(Get)

pbHasCoverPageVARIANT_BOOL*out受信メッセージがカバーページを含むかを受け取るVARIANT_BOOLポインタ。

解説(Remarks)

受信メッセージは、到着した時点では VARIANT_FALSE 値です。再割り当てされる際に、ルーティング アシスタントアプリケーションがこの値を VARIANT_TRUE に設定できます。

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

vtbl 27 HRESULT put_HasCoverPage(VARIANT_BOOL bHasCoverPage)

FAX にカバー ページがあるかどうかを示すフラグです。(Put)

bHasCoverPageVARIANT_BOOLin受信メッセージにカバーページがあるかを設定するVARIANT_BOOL。

解説(Remarks)

受信メッセージは、到着した時点では VARIANT_FALSE 値です。再割り当てされる際に、ルーティング アシスタントアプリケーションがこの値を VARIANT_TRUE に設定できます。

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

vtbl 28 HRESULT get_Recipients(LPWSTR* pbstrRecipients)

受信 FAX メッセージに関連付けられた受信者を格納します。このプロパティは null 終端文字列です。(Get)

pbstrRecipientsLPWSTR*out受信者一覧を表す文字列を受け取るBSTRポインタ。

解説(Remarks)

受信メッセージは、到着した時点では受信者が null 値です。再割り当てされる際に、ルーティング アシスタントによって受信者の一覧を指定できます。

各受信者は <DomainName>&lt;UserName> という形式で識別されます。受信者どうしはコロン ":" で区切られます。ローカル ユーザーの場合、<DomainName> はローカル コンピューター名になります。

vtbl 29 HRESULT put_Recipients(LPWSTR bstrRecipients)

受信 FAX メッセージに関連付けられた受信者を格納します。このプロパティは null 終端文字列です。(Put)

bstrRecipientsLPWSTRin受信者一覧を表す文字列を設定するBSTR。

解説(Remarks)

受信メッセージは、到着した時点では受信者が null 値です。再割り当てされる際に、ルーティング アシスタントによって受信者の一覧を指定できます。

各受信者は <DomainName>&lt;UserName> という形式で識別されます。受信者どうしはコロン ":" で区切られます。ローカル ユーザーの場合、<DomainName> はローカル コンピューター名になります。

vtbl 30 HRESULT get_WasReAssigned(VARIANT_BOOL* pbWasReAssigned)

FAX が再割り当てされたかどうかを示します。

pbWasReAssignedVARIANT_BOOL*outメッセージが他ユーザーに再割り当てされたかを受け取るVARIANT_BOOLポインタ。

解説(Remarks)

FAX がサーバーに到着した時点では、このプロパティは常に VARIANT_FALSE です。ルーティング アシスタントによって再割り当てされると、FAX サービスはこの値を VARIANT_TRUE に設定します。

vtbl 31 HRESULT get_Read(VARIANT_BOOL* pbRead)

FAX が既読かどうかを示すフラグです。(Get)

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

解説(Remarks)

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

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

vtbl 32 HRESULT put_Read(VARIANT_BOOL bRead)

FAX が既読かどうかを示すフラグです。(Put)

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

解説(Remarks)

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

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

vtbl 33 HRESULT ReAssign()

FAX を 1 人以上の受信者に再割り当てします。また、IFaxIncomingMessage2::Subject、IFaxIncomingMessage2::SenderName、IFaxIncomingMessage2::SenderFaxNumber、および IFaxIncomingMessage2::HasCoverPage の各プロパティへの変更も確定します。

戻り値

型: HRESULT

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

解説(Remarks)

このメソッドを使用するには、ユーザーが far2MANAGE_RECEIVE_FOLDER および far2QUERY_CONFIG のアクセス権を持っている必要があります。また、IFaxConfiguration::IncomingFaxesArePublic が false に設定されている必要があります。

ルーティング アシスタントアプリケーションが IFaxIncomingMessage2::Subject、IFaxIncomingMessage2::SenderName、IFaxIncomingMessage2::SenderFaxNumber、または IFaxIncomingMessage2::HasCoverPage の各プロパティを設定する場合は、IFaxIncomingMessage2::Reassign を呼び出す前に設定してください。Reassign がこれらの変更を確定するため、IFaxIncomingMessage2::Save を呼び出す必要はありません。

vtbl 34 HRESULT Save()

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

戻り値

型: HRESULT

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

解説(Remarks)

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

IFaxIncomingMessage2::Subject、IFaxIncomingMessage2::SenderName、IFaxIncomingMessage2::SenderFaxNumber、および IFaxIncomingMessage2::HasCoverPage の各プロパティへの変更を確定するために、このメソッドを呼び出す必要はありません。これらは IFaxIncomingMessage2::Reassign メソッドによって確定されます。

vtbl 35 HRESULT Refresh()

FAX サーバーから FaxIncomingMessage オブジェクトの情報を更新します。

戻り値

型: 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_IFaxIncomingMessage2 "{F9208503-E2BC-48F3-9EC0-E6236F9B509A}"
#usecom global IFaxIncomingMessage2 IID_IFaxIncomingMessage2 "{1932FCF7-9D43-4D5A-89FF-03861B321736}"
#comfunc global IFaxIncomingMessage2_get_Subject          20 var
#comfunc global IFaxIncomingMessage2_put_Subject          21 wstr
#comfunc global IFaxIncomingMessage2_get_SenderName       22 var
#comfunc global IFaxIncomingMessage2_put_SenderName       23 wstr
#comfunc global IFaxIncomingMessage2_get_SenderFaxNumber  24 var
#comfunc global IFaxIncomingMessage2_put_SenderFaxNumber  25 wstr
#comfunc global IFaxIncomingMessage2_get_HasCoverPage     26 var
#comfunc global IFaxIncomingMessage2_put_HasCoverPage     27 int
#comfunc global IFaxIncomingMessage2_get_Recipients       28 var
#comfunc global IFaxIncomingMessage2_put_Recipients       29 wstr
#comfunc global IFaxIncomingMessage2_get_WasReAssigned    30 var
#comfunc global IFaxIncomingMessage2_get_Read             31 var
#comfunc global IFaxIncomingMessage2_put_Read             32 int
#comfunc global IFaxIncomingMessage2_ReAssign             33
#comfunc global IFaxIncomingMessage2_Save                 34
#comfunc global IFaxIncomingMessage2_Refresh              35
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※#usecom 末尾は CoCreateInstance 用のクラスID(コクラスCLSID, SDKから自動取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。