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

IFaxDevices

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

公式ドキュメント

IFaxDevices インターフェイスは、FAX クライアント アプリケーションが FAX デバイスを管理するために使用するコレクションを定義します。各デバイスは FaxDevice オブジェクトとして表されます。

解説(Remarks)

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

メソッド 4

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

vtbl 7 HRESULT get__NewEnum(IUnknown** ppUnk)

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

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

戻り値

型: HRESULT

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

解説(Remarks)

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

vtbl 8 HRESULT get_Item(VARIANT vIndex, IFaxDevice** pFaxDevice)

IFaxDevices::get_Item メソッドは、インデックスを使用して FaxDevices コレクションから FaxDevice オブジェクトを返します。

vIndexVARIANTinFAX デバイス コレクションから取得する項目のインデックスを指定する VARIANT です。このパラメーターが VT_I2 型または VT_I4 型の場合、コレクションから取得する項目のインデックスを指定します。インデックスの有効な値は 1 から n の範囲です。n は IFaxDevices::get_Count メソッドの呼び出しによって返されるデバイス数です。このパラメーターが VT_BSTR 型の場合、取得する FAX デバイスの一意の名前を含む文字列になります。その他の型はサポートされていません。
pFaxDeviceIFaxDevice**outFaxDevice オブジェクトへのポインターのアドレスを受け取ります。

戻り値

型: HRESULT

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

解説(Remarks)

デバイス ID を使用して FaxDevices コレクションから項目を取得するには、IFaxDevices::get_ItemById プロパティを呼び出します。

vtbl 9 HRESULT get_Count(INT* plCount)

IFaxDevices::get_Count プロパティは、FaxDevices コレクション内のオブジェクトの数を表します。これは FAX サーバーが使用するデバイスの総数です。

plCountINT*outFAXデバイスの総数を受け取る出力先。
vtbl 10 HRESULT get_ItemById(INT lId, IFaxDevice** ppFaxDevice)

IFaxDevices::get_ItemById メソッドは、デバイス ID を使用して FaxDevices コレクションから FaxDevice オブジェクトを返します。

lIdINTin取得するデバイスの一意の ID です。
ppFaxDeviceIFaxDevice**outFaxDevice オブジェクトです。

戻り値

型: HRESULT

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

解説(Remarks)

デバイスのインデックスを使用して FaxDevices コレクションから項目を取得するには、Item プロパティを呼び出します。

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