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

IFaxOutboundRoutingRule

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

公式ドキュメント

IFaxOutboundRoutingRule インターフェイスは、FAX クライアント アプリケーションが個々の FAX 送信ルーティング規則に関する情報を設定および取得するために使用する構成オブジェクトを表します。

解説(Remarks)

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

メソッド 11

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

vtbl 7 HRESULT get_CountryCode(INT* plCountryCode)

IFaxOutboundRoutingRule::get_CountryCode プロパティは、この送信ルーティング規則が適用される国/地域コードを指定します。

plCountryCodeINT*outルールが対象とする国番号を受け取るINTポインタ。

解説(Remarks)

このプロパティが frrcANY_CODE と等しい場合、この送信ルーティング規則はすべての国/地域コードに適用されます。

このプロパティを読み取るには、ユーザーが farQUERY_CONFIG アクセス権を持っている必要があります。

vtbl 8 HRESULT get_AreaCode(INT* plAreaCode)

IFaxOutboundRoutingRule::get_AreaCode プロパティは、この送信ルーティング規則が適用される市外局番を指定します。

plAreaCodeINT*outルールが対象とする市外局番を受け取るINTポインタ。任意を表す特殊値もあり得る。

解説(Remarks)

このプロパティが frrcANY_CODE と等しい場合、この送信ルーティング規則はすべての市外局番に適用されます。

このプロパティを読み取るには、ユーザーが farQUERY_CONFIG アクセス権を持っている必要があります。

vtbl 9 HRESULT get_Status(FAX_RULE_STATUS_ENUM* pStatus)

IFaxOutboundRoutingRule::get_Status プロパティは、送信ルーティング規則の現在の状態 (たとえば、規則が有効かどうか、FAX ジョブに適用できるかどうか) を示します。

pStatusFAX_RULE_STATUS_ENUM*outルールの状態を表すFAX_RULE_STATUS_ENUM値を受け取るポインタ。有効/空グループ等を示す。

解説(Remarks)

このプロパティを読み取るには、ユーザーが farQUERY_CONFIG アクセス権を持っている必要があります。

vtbl 10 HRESULT get_UseDevice(VARIANT_BOOL* pbUseDevice)

IFaxOutboundRoutingRule::get_UseDevice プロパティは、送信ルーティング規則が単一の FAX デバイスを指しているかどうかを示すブール値です。(Get)

pbUseDeviceVARIANT_BOOL*outルーティング先が個別デバイスか(VARIANT_TRUE)グループか(VARIANT_FALSE)を受け取るVARIANT_BOOLポインタ。

解説(Remarks)

このプロパティを読み取るまたは書き込むには、ユーザーが farQUERY_CONFIG アクセス権を持っている必要があります。

vtbl 11 HRESULT put_UseDevice(VARIANT_BOOL bUseDevice)

IFaxOutboundRoutingRule::get_UseDevice プロパティは、送信ルーティング規則が単一の FAX デバイスを指しているかどうかを示すブール値です。(Put)

bUseDeviceVARIANT_BOOLinルーティング先に個別デバイスを使うかを設定するVARIANT_BOOL。

解説(Remarks)

このプロパティを読み取るまたは書き込むには、ユーザーが farQUERY_CONFIG アクセス権を持っている必要があります。

vtbl 12 HRESULT get_DeviceId(INT* plDeviceId)

IFaxOutboundRoutingRule::get_DeviceId プロパティは、送信ルーティング規則が単一の FAX デバイスを指している場合に、そのデバイス ID を指定します。(Get)

plDeviceIdINT*outルーティング先の個別デバイスIDを受け取るINTポインタ。

解説(Remarks)

このプロパティは、IFaxOutboundRoutingRule::get_UseDevice プロパティが TRUE の場合にのみ有効です。

このプロパティを読み取るまたは書き込むには、ユーザーが farQUERY_CONFIG アクセス権を持っている必要があります。

vtbl 13 HRESULT put_DeviceId(INT DeviceId)

IFaxOutboundRoutingRule::get_DeviceId プロパティは、送信ルーティング規則が単一の FAX デバイスを指している場合に、そのデバイス ID を指定します。(Put)

DeviceIdINTinルーティング先の個別デバイスIDを設定するINT。

解説(Remarks)

このプロパティは、IFaxOutboundRoutingRule::get_UseDevice プロパティが TRUE の場合にのみ有効です。

このプロパティを読み取るまたは書き込むには、ユーザーが farQUERY_CONFIG アクセス権を持っている必要があります。

vtbl 14 HRESULT get_GroupName(LPWSTR* pbstrGroupName)

IFaxOutboundRoutingRule::get_GroupName プロパティは、送信ルーティング規則が FAX デバイスのグループを指している場合に、そのグループ名を指定します。(Get)

pbstrGroupNameLPWSTR*outルーティング先グループ名を受け取るBSTRポインタ。

解説(Remarks)

このプロパティは、IFaxOutboundRoutingRule::get_UseDevice プロパティが FALSE の場合にのみ有効です。

このプロパティを読み取るまたは書き込むには、ユーザーが farQUERY_CONFIG アクセス権を持っている必要があります。

vtbl 15 HRESULT put_GroupName(LPWSTR bstrGroupName)

IFaxOutboundRoutingRule::get_GroupName プロパティは、送信ルーティング規則が FAX デバイスのグループを指している場合に、そのグループ名を指定します。(Put)

bstrGroupNameLPWSTRinルーティング先グループ名を設定するBSTR。

解説(Remarks)

このプロパティは、IFaxOutboundRoutingRule::get_UseDevice プロパティが FALSE の場合にのみ有効です。

このプロパティを読み取るまたは書き込むには、ユーザーが farQUERY_CONFIG アクセス権を持っている必要があります。

vtbl 16 HRESULT Refresh()

IFaxOutboundRoutingRule::Refresh メソッドは、FaxOutboundRoutingRule オブジェクトの情報を FAX サーバーから再取得します。

戻り値

型: HRESULT

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

解説(Remarks)

IFaxOutboundRoutingRule::Refresh メソッドを呼び出すと、最後に IFaxOutboundRoutingRule::Save メソッドを呼び出した後に行った構成の変更はすべて失われます。

vtbl 17 HRESULT Save()

IFaxOutboundRoutingRule::Save メソッドは、FaxOutboundRoutingRule オブジェクトのデータを保存します。

戻り値

型: HRESULT

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

解説(Remarks)

このメソッドを使用するには、ユーザーが farMANAGE_CONFIG および farQUERY_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_IFaxOutboundRoutingRule "{E1F795D5-07C2-469F-B027-ACACC23219DA}"
#usecom global IFaxOutboundRoutingRule IID_IFaxOutboundRoutingRule "{}"
#comfunc global IFaxOutboundRoutingRule_get_CountryCode  7 var
#comfunc global IFaxOutboundRoutingRule_get_AreaCode     8 var
#comfunc global IFaxOutboundRoutingRule_get_Status       9 var
#comfunc global IFaxOutboundRoutingRule_get_UseDevice    10 var
#comfunc global IFaxOutboundRoutingRule_put_UseDevice    11 int
#comfunc global IFaxOutboundRoutingRule_get_DeviceId     12 var
#comfunc global IFaxOutboundRoutingRule_put_DeviceId     13 int
#comfunc global IFaxOutboundRoutingRule_get_GroupName    14 var
#comfunc global IFaxOutboundRoutingRule_put_GroupName    15 wstr
#comfunc global IFaxOutboundRoutingRule_Refresh          16
#comfunc global IFaxOutboundRoutingRule_Save             17
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。