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

IFaxIncomingMessageIterator

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

公式ドキュメント

IFaxIncomingMessageIterator インターフェイスは、FAX サービスが正常に受信した受信 FAX メッセージのアーカイブ内を移動するために、FAX クライアント アプリケーションが使用します。

解説(Remarks)

C++ で FaxIncomingMessageIterator オブジェクトを作成するには、IFaxIncomingArchive::GetMessages メソッドを呼び出します。

メソッド 6

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

vtbl 7 HRESULT get_Message(IFaxIncomingMessage** pFaxIncomingMessage)

Message プロパティは、アーカイブ カーソルが指している受信 FAX メッセージを取得します。

pFaxIncomingMessageIFaxIncomingMessage**out現在の反復位置の受信メッセージを表すインターフェイスを受け取るポインタ。

解説(Remarks)

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

vtbl 8 HRESULT get_PrefetchSize(INT* plPrefetchSize)

PrefetchSize プロパティは、プリフェッチ (先読み) バッファーのサイズを示します。(Get)

plPrefetchSizeINT*out一度に先読みするメッセージ数を受け取るINTポインタ。

解説(Remarks)

プリフェッチ バッファーにはメッセージが格納され、フォルダーではなくバッファー内を反復処理できるため、反復処理がより効率的になります。

FaxIncomingMessageIterator はローカル オブジェクトであるため、プリフェッチ バッファーのサイズに対する変更は直ちに反映されます。

lPrefetchSize プロパティの値は、イテレーター オブジェクトが内容を更新するたびにアーカイブから取得する FAX メッセージの数を決定します。既定値は lDEFAULT_PREFETCH_SIZE です。

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

vtbl 9 HRESULT put_PrefetchSize(INT lPrefetchSize)

PrefetchSize プロパティは、プリフェッチ (先読み) バッファーのサイズを示します。(Put)

lPrefetchSizeINTin一度に先読みするメッセージ数を設定するINT。

解説(Remarks)

プリフェッチ バッファーにはメッセージが格納され、フォルダーではなくバッファー内を反復処理できるため、反復処理がより効率的になります。

FaxIncomingMessageIterator はローカル オブジェクトであるため、プリフェッチ バッファーのサイズに対する変更は直ちに反映されます。

lPrefetchSize プロパティの値は、イテレーター オブジェクトが内容を更新するたびにアーカイブから取得する FAX メッセージの数を決定します。既定値は lDEFAULT_PREFETCH_SIZE です。

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

vtbl 10 HRESULT get_AtEOF(VARIANT_BOOL* pbEOF)

AtEOF プロパティは、受信 FAX メッセージのアーカイブにおけるファイル終端マーカーです。

pbEOFVARIANT_BOOL*out反復子が末尾(これ以上要素なし)に達したかを受け取るVARIANT_BOOLポインタ。

解説(Remarks)

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

vtbl 11 HRESULT MoveFirst()

MoveFirst メソッドは、アーカイブ カーソルを受信 FAX のアーカイブ内の最初の FAX メッセージへ移動します。

戻り値

型: HRESULT

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

解説(Remarks)

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

vtbl 12 HRESULT MoveNext()

MoveNext メソッドは、アーカイブ カーソルを受信 FAX のアーカイブ内の次のメッセージへ移動します。

戻り値

型: HRESULT

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

解説(Remarks)

プリフェッチ バッファーを使用すると、反復処理をより効率的にできます。プリフェッチ バッファーにはメッセージが格納され、フォルダーではなくバッファー内を反復処理できます。バッファーのサイズ (バッファーに保持するメッセージ数) は、PrefetchSize プロパティで設定します。

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IFaxIncomingMessageIterator "{FD73ECC4-6F06-4F52-82A8-F7BA06AE3108}"
#usecom global IFaxIncomingMessageIterator IID_IFaxIncomingMessageIterator "{}"
#comfunc global IFaxIncomingMessageIterator_get_Message       7 sptr
#comfunc global IFaxIncomingMessageIterator_get_PrefetchSize  8 var
#comfunc global IFaxIncomingMessageIterator_put_PrefetchSize  9 int
#comfunc global IFaxIncomingMessageIterator_get_AtEOF         10 var
#comfunc global IFaxIncomingMessageIterator_MoveFirst         11
#comfunc global IFaxIncomingMessageIterator_MoveNext          12
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。