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

IFaxActivity

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

公式ドキュメント

IFaxActivity インターフェイスは、読み取り専用の構成オブジェクトを定義します。

解説(Remarks)

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

FAX サービスが送受信の FAX ジョブに関する情報をアクティビティログデータベースに記録するかどうかを構成できます。FaxActivityLogging 構成オブジェクトを使用すると、FAX サービスが使用するアクティビティログのオプションを構成できます。

メソッド 5

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

vtbl 7 HRESULT get_IncomingMessages(INT* plIncomingMessages)

IFaxActivity::get_IncomingMessages プロパティは、FAX サービスが現在受信処理中の受信 FAX ジョブの総数を表す数値です。

plIncomingMessagesINT*out現在受信中のメッセージ数を受け取る出力先。

解説(Remarks)

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

vtbl 8 HRESULT get_RoutingMessages(INT* plRoutingMessages)

IFaxActivity::get_RoutingMessages プロパティは、FAX サービスが現在ルーティング中の受信 FAX ジョブの総数を表す数値です。

plRoutingMessagesINT*out現在ルーティング処理中のメッセージ数を受け取る出力先。

解説(Remarks)

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

vtbl 9 HRESULT get_OutgoingMessages(INT* plOutgoingMessages)

IFaxActivity::get_OutgoingMessages プロパティは、FAX サービスが現在送信処理中の送信 FAX ジョブの総数を表す数値です。

plOutgoingMessagesINT*out現在送信中のメッセージ数を受け取る出力先。

解説(Remarks)

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

vtbl 10 HRESULT get_QueuedMessages(INT* plQueuedMessages)

IFaxActivity::get_QueuedMessages プロパティは、FAX ジョブキュー内で処理待ちになっている FAX ジョブの総数を表す数値です。再試行回数の上限を超えたジョブは含まれません。

plQueuedMessagesINT*out送信キューで待機中のメッセージ数を受け取る出力先。

解説(Remarks)

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

vtbl 11 HRESULT Refresh()

IFaxActivity::Refresh メソッドは、FAX サーバーから FaxActivity の情報を再取得して更新します。

戻り値

型: HRESULT

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

解説(Remarks)

このメソッドを使用するには、ユーザーが 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_IFaxActivity "{4B106F97-3DF5-40F2-BC3C-44CB8115EBDF}"
#usecom global IFaxActivity IID_IFaxActivity "{}"
#comfunc global IFaxActivity_get_IncomingMessages  7 var
#comfunc global IFaxActivity_get_RoutingMessages   8 var
#comfunc global IFaxActivity_get_OutgoingMessages  9 var
#comfunc global IFaxActivity_get_QueuedMessages    10 var
#comfunc global IFaxActivity_Refresh               11
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。