ホーム › Devices.Fax › IFaxOutgoingMessageIterator

IFaxOutgoingMessageIterator

COMIDispatch (デュアル)

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

IIDf5ec5d4f-b840-432f-9980-112fe42a9b7a継承元IDispatch呼び出し名前(IDispatch) または vtbl自前メソッド開始 vtbl7

公式ドキュメント

IFaxOutgoingMessageIterator インターフェイスは、FAX サービスが送信に成功した FAX メッセージのアーカイブ (FaxOutgoingMessage オブジェクトで表されます) を FAX クライアントアプリケーションが順に移動するために使用するオブジェクトを表します。

解説(Remarks)

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

メソッド 6

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

vtbl 7 HRESULT get_Message(IFaxOutgoingMessage** pFaxOutgoingMessage)

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

pFaxOutgoingMessage

IFaxOutgoingMessage**

out

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

解説(Remarks)

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

vtbl 8 HRESULT get_AtEOF(VARIANT_BOOL* pbEOF)

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

pbEOF

VARIANT_BOOL*

out

反復子が末尾に達したかを受け取るVARIANT_BOOLポインタ。VARIANT_TRUEで末尾。

解説(Remarks)

このプロパティが TRUE の場合、アーカイブカーソルはアーカイブ内の最後の FAX メッセージを越えて移動しています。このプロパティが FALSE の場合、アーカイブカーソルはアーカイブの終端に達していません。

vtbl 9 HRESULT get_PrefetchSize(INT* plPrefetchSize)

IFaxOutgoingMessageIterator::get_PrefetchSize プロパティは、プリフェッチ (先読み) バッファーのサイズを示します。これは、イテレーターオブジェクトが内容を更新する必要があるときに FAX サーバーから取得する FAX メッセージの数を決定します。(Get)

plPrefetchSize

INT*

out

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

vtbl 10 HRESULT put_PrefetchSize(INT lPrefetchSize)

IFaxOutgoingMessageIterator::get_PrefetchSize プロパティは、プリフェッチ (先読み) バッファーのサイズを示します。これは、イテレーターオブジェクトが内容を更新する必要があるときに FAX サーバーから取得する FAX メッセージの数を決定します。(Put)

lPrefetchSize

INT

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

vtbl 11 HRESULT MoveFirst()

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

戻り値

型: HRESULT

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

解説(Remarks)

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

vtbl 12 HRESULT MoveNext()

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

戻り値

型: HRESULT

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

解説(Remarks)

IFaxOutgoingMessageIterator::get_AtEOF プロパティが TRUE の場合、このメソッドは失敗します。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IFaxOutgoingMessageIterator "{F5EC5D4F-B840-432F-9980-112FE42A9B7A}"
#usecom global IFaxOutgoingMessageIterator IID_IFaxOutgoingMessageIterator "{}"
#comfunc global IFaxOutgoingMessageIterator_get_Message       7 sptr
#comfunc global IFaxOutgoingMessageIterator_get_AtEOF         8 var
#comfunc global IFaxOutgoingMessageIterator_get_PrefetchSize  9 var
#comfunc global IFaxOutgoingMessageIterator_put_PrefetchSize  10 int
#comfunc global IFaxOutgoingMessageIterator_MoveFirst         11
#comfunc global IFaxOutgoingMessageIterator_MoveNext          12
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。#define global IID_IFaxOutgoingMessageIterator "{F5EC5D4F-B840-432F-9980-112FE42A9B7A}"
#usecom global IFaxOutgoingMessageIterator IID_IFaxOutgoingMessageIterator "{}"
#comfunc global IFaxOutgoingMessageIterator_get_Message       7 sptr
#comfunc global IFaxOutgoingMessageIterator_get_AtEOF         8 sptr
#comfunc global IFaxOutgoingMessageIterator_get_PrefetchSize  9 sptr
#comfunc global IFaxOutgoingMessageIterator_put_PrefetchSize  10 int
#comfunc global IFaxOutgoingMessageIterator_MoveFirst         11
#comfunc global IFaxOutgoingMessageIterator_MoveNext          12
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。