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

IFaxRecipients

COMIDispatch (デュアル)
IDispatch を実装(デュアルインターフェース)。HSP では comobj 経由でメソッド名による遅延バインド呼び出しができます(vtableインデックス不要)。
IIDb9c9de5a-894e-4492-9fa3-08c627c11d5d継承元IDispatch呼び出し名前(IDispatch) または vtbl自前メソッド開始 vtbl7

公式ドキュメント

IFaxRecipients インターフェイスは、FAX クライアント アプリケーションが 1 つの FAX ドキュメントの受信者を表す FAX 受信者オブジェクト (FaxRecipient) を管理するために使用する、FaxRecipients メッセージング コレクションを定義します。

解説(Remarks)

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

メソッド 5

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

vtbl 7 HRESULT get__NewEnum(IUnknown** ppUnk)

IFaxRecipients::get__NewEnum メソッドは、FaxRecipients コレクションを反復処理するために使用できる列挙子オブジェクトへの参照を返します。

ppUnkIUnknown**outコレクションの列挙子オブジェクトの IUnknown インターフェイスへの間接ポインターを受け取ります。

戻り値

型: HRESULT

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

解説(Remarks)

Microsoft Visual Basic では、_NewEnum プロパティは For Each ... Next の実装で自動的に使用されるため、明示的に使用する必要はありません。

vtbl 8 HRESULT get_Item(INT lIndex, IFaxRecipient** ppFaxRecipient)

Item メソッドは、FaxRecipients コレクションから FaxRecipient オブジェクトを返します。

lIndexINTinFAX 受信者コレクションから取得する項目を指定する LONG 値です。このパラメーターの有効な値は 1 から n までの範囲です。nIFaxRecipients::get_Count メソッドの呼び出しによって返される受信者の数です。
ppFaxRecipientIFaxRecipient**outIFaxRecipient インターフェイスへのポインターのアドレスです。

戻り値

型: HRESULT

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

vtbl 9 HRESULT get_Count(INT* plCount)

IFaxRecipients::get_Count プロパティは、FaxRecipients コレクション内のオブジェクトの数を表します。これは、FAX サーバーまたは FAX ドキュメントに関連付けられている受信者の総数です。

plCountINT*out宛先の総数を受け取る出力先。
vtbl 10 HRESULT Add(LPWSTR bstrFaxNumber, LPWSTR bstrRecipientName, IFaxRecipient** ppFaxRecipient)

IFaxRecipients::Add メソッドは、新しい FaxRecipient オブジェクトを FaxRecipients コレクションに追加します。

bstrFaxNumberLPWSTRinFAX 受信者の FAX 番号を指定します。
bstrRecipientNameLPWSTRinFAX 受信者の名前を指定します。
ppFaxRecipientIFaxRecipient**outFaxRecipient オブジェクトです。

戻り値

型: HRESULT

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

vtbl 11 HRESULT Remove(INT lIndex)

IFaxRecipients::Remove メソッドは、FaxRecipients コレクションから項目を削除します。

lIndexINTinコレクションから削除する項目のインデックスを指定する LONG です。このパラメーターの有効な値は 1 から n までの範囲です。nIFaxRecipients::get_Count メソッドの呼び出しによって返される受信者の数です。

戻り値

型: HRESULT

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IFaxRecipients "{B9C9DE5A-894E-4492-9FA3-08C627C11D5D}"
#usecom global IFaxRecipients IID_IFaxRecipients "{}"
#comfunc global IFaxRecipients_get__NewEnum  7 sptr
#comfunc global IFaxRecipients_get_Item      8 int,sptr
#comfunc global IFaxRecipients_get_Count     9 var
#comfunc global IFaxRecipients_Add           10 wstr,wstr,sptr
#comfunc global IFaxRecipients_Remove        11 int
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。