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

IFaxDeviceIds

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

公式ドキュメント

IFaxDeviceIds インターフェイスは、FAX クライアント アプリケーションが FaxOutboundRoutingGroup オブジェクトに関連付けられた順序付きの FAX デバイス ID を列挙するために使用する構成コレクションを定義します。

解説(Remarks)

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

メソッド 6

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

vtbl 7 HRESULT get__NewEnum(IUnknown** ppUnk)

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

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

戻り値

型: HRESULT

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

解説(Remarks)

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

vtbl 8 HRESULT get_Item(INT lIndex, INT* plDeviceId)

IFaxDeviceIds::get_Item メソッドは、FaxDeviceIds コレクション内のデバイス ID を表します。

lIndexINTinコレクションから取得する項目を指定する値です。このパラメーターの有効な値は 1 から n までの範囲です。n は IFaxDeviceIds::get_Count メソッドの呼び出しによって返されるデバイスの数です。
plDeviceIdINT*out要求された項目を受け取る値へのポインターです。

戻り値

型: HRESULT

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

vtbl 9 HRESULT get_Count(INT* plCount)

IFaxDeviceIds::get_Count プロパティは、FaxDeviceIds コレクション内のオブジェクトの数を表します。これは FAX サーバーに関連付けられたデバイス ID の総数です。

plCountINT*outコレクション内のデバイスID数を受け取るINTポインタ。
vtbl 10 HRESULT Add(INT lDeviceId)

IFaxDeviceIds::Add メソッドは、デバイスの ID を使用して FAX デバイスを FaxDeviceIds コレクションに追加します。

lDeviceIdINTinコレクションに追加する FAX デバイスの ID を指定する long 値です。

戻り値

型: HRESULT

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

解説(Remarks)

このメソッドはリモート プロシージャ コール (RPC) の戻り値を返すこともあります。詳細については、「RPC Return Values」を参照してください。

注意 特殊な All Devices ルーティング グループにデバイスを追加することはできません。また、追加できるのは有効なデバイス ID のみです。FaxDeviceIds コレクション内のデバイスの有効な ID は、Id プロパティから取得できます。
このメソッドを使用するには、ユーザーが farMANAGE_CONFIG アクセス権を持っている必要があります。
vtbl 11 HRESULT Remove(INT lIndex)

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

lIndexINTinコレクションから削除する項目のインデックスを指定する long 値です。このパラメーターの有効な値は 1 から n までの範囲です。n は IFaxDeviceIds::get_Count プロパティの呼び出しによって返されるデバイスの数です。

戻り値

型: HRESULT

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

解説(Remarks)

注意 特殊な All Devices ルーティング グループからデバイスを削除することはできません。
このメソッドを使用するには、ユーザーが farMANAGE_CONFIG アクセス権を持っている必要があります。
vtbl 12 HRESULT SetOrder(INT lDeviceId, INT lNewOrder)

IFaxDeviceIds::SetOrder メソッドは、順序付き FaxDeviceIds コレクション内でのデバイスの順序を変更します。

lDeviceIdINTin順序を変更するデバイスのデバイス ID を指定します。
lNewOrderINTin順序内でのデバイスの新しい位置を指定します。

戻り値

型: HRESULT

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

解説(Remarks)

デバイスをそのデバイス ID で指定し、順序内での新しい位置を選択します。デバイスを順序の先頭に近づけると、その位置より下にあったデバイスは変更に合わせて 1 つずつ下がります。デバイスを順序の末尾に近づけると、その位置より上にあったデバイスは変更によって生じた空きを埋めるために 1 つずつ上がります。

FAX デバイス グループでは、グループ内でのデバイスの相対的な順序が重要です。FAX サービスは送信ジョブを開始するとき、デバイス グループ内の最初の FAX デバイスを選択しようとします。そのデバイスが利用できない場合、サービスは順位が次に続く利用可能なデバイスを選択し、以降も同様に処理します。詳細については、「Fax Device Groups」を参照してください。

このメソッドを使用するには、ユーザーが farMANAGE_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_IFaxDeviceIds "{2F0F813F-4CE9-443E-8CA1-738CFAEEE149}"
#usecom global IFaxDeviceIds IID_IFaxDeviceIds "{}"
#comfunc global IFaxDeviceIds_get__NewEnum  7 sptr
#comfunc global IFaxDeviceIds_get_Item      8 int,var
#comfunc global IFaxDeviceIds_get_Count     9 var
#comfunc global IFaxDeviceIds_Add           10 int
#comfunc global IFaxDeviceIds_Remove        11 int
#comfunc global IFaxDeviceIds_SetOrder      12 int,int
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。