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

IFaxActivityLogging

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

公式ドキュメント

IFaxActivityLogging インターフェイスは、FAX クライアント アプリケーションがアクティビティ ログのオプションを取得および設定するために使用する構成オブジェクトを定義します。

解説(Remarks)

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

メソッド 8

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

vtbl 7 HRESULT get_LogIncoming(VARIANT_BOOL* pbLogIncoming)

IFaxActivityLogging::get_LogIncoming プロパティは、FAX サービスが受信 FAX のエントリをアクティビティ ログ データベースに記録するかどうかを示すブール値です。(Get)

pbLogIncomingVARIANT_BOOL*out受信アクティビティのログ記録が有効かを受け取るVARIANT_BOOLポインタ。

解説(Remarks)

このプロパティが TRUE の場合、FAX サービスは受信 FAX ジョブのエントリをアクティビティ ログ データベースに記録します。このプロパティが FALSE の場合、FAX サービスはエントリを記録しません。

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

vtbl 8 HRESULT put_LogIncoming(VARIANT_BOOL bLogIncoming)

IFaxActivityLogging::get_LogIncoming プロパティは、FAX サービスが受信 FAX のエントリをアクティビティ ログ データベースに記録するかどうかを示すブール値です。(Put)

bLogIncomingVARIANT_BOOLin受信アクティビティのログ記録の有効/無効を設定するVARIANT_BOOL。

解説(Remarks)

このプロパティが TRUE の場合、FAX サービスは受信 FAX ジョブのエントリをアクティビティ ログ データベースに記録します。このプロパティが FALSE の場合、FAX サービスはエントリを記録しません。

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

vtbl 9 HRESULT get_LogOutgoing(VARIANT_BOOL* pbLogOutgoing)

IFaxActivityLogging::get_LogOutgoing プロパティは、FAX サービスが送信 FAX のエントリをアクティビティ ログ データベースに記録するかどうかを示すブール値です。(Get)

pbLogOutgoingVARIANT_BOOL*out送信アクティビティのログ記録が有効かを受け取るVARIANT_BOOLポインタ。

解説(Remarks)

このプロパティが TRUE の場合、FAX サービスは送信 FAX ジョブのエントリをアクティビティ ログ データベースに記録します。このプロパティが FALSE の場合、FAX サービスはエントリを記録しません。

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

vtbl 10 HRESULT put_LogOutgoing(VARIANT_BOOL bLogOutgoing)

IFaxActivityLogging::get_LogOutgoing プロパティは、FAX サービスが送信 FAX のエントリをアクティビティ ログ データベースに記録するかどうかを示すブール値です。(Put)

bLogOutgoingVARIANT_BOOLin送信アクティビティのログ記録の有効/無効を設定するVARIANT_BOOL。

解説(Remarks)

このプロパティが TRUE の場合、FAX サービスは送信 FAX ジョブのエントリをアクティビティ ログ データベースに記録します。このプロパティが FALSE の場合、FAX サービスはエントリを記録しません。

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

vtbl 11 HRESULT get_DatabasePath(LPWSTR* pbstrDatabasePath)

IFaxActivityLogging::get_DatabasePath プロパティは、アクティビティ ログ データベース ファイルへのパスを含む null 終端文字列です。(Get)

pbstrDatabasePathLPWSTR*outアクティビティログを格納するデータベースのパスを受け取るBSTRポインタ。

解説(Remarks)

メモ アクティビティ ログ ディレクトリへのパスを変更する場合は、必ずセキュリティで保護されたディレクトリを使用してください。
このプロパティの読み取りまたは書き込みを行うには、ユーザーが farQUERY_CONFIG アクセス権を持っている必要があります。
vtbl 12 HRESULT put_DatabasePath(LPWSTR bstrDatabasePath)

IFaxActivityLogging::get_DatabasePath プロパティは、アクティビティ ログ データベース ファイルへのパスを含む null 終端文字列です。(Put)

bstrDatabasePathLPWSTRinアクティビティログを格納するデータベースのパスを設定するBSTR。

解説(Remarks)

メモ アクティビティ ログ ディレクトリへのパスを変更する場合は、必ずセキュリティで保護されたディレクトリを使用してください。
このプロパティの読み取りまたは書き込みを行うには、ユーザーが farQUERY_CONFIG アクセス権を持っている必要があります。
vtbl 13 HRESULT Refresh()

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

戻り値

型: HRESULT

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

解説(Remarks)

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

このメソッドを使用するには、ユーザーが farQUERY_CONFIG アクセス権を持っている必要があります。

vtbl 14 HRESULT Save()

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

戻り値

型: HRESULT

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

解説(Remarks)

このメソッドを使用するには、ユーザーが farQUERY_CONFIG および 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_IFaxActivityLogging "{1E29078B-5A69-497B-9592-49B7E7FADDB5}"
#usecom global IFaxActivityLogging IID_IFaxActivityLogging "{}"
#comfunc global IFaxActivityLogging_get_LogIncoming   7 var
#comfunc global IFaxActivityLogging_put_LogIncoming   8 int
#comfunc global IFaxActivityLogging_get_LogOutgoing   9 var
#comfunc global IFaxActivityLogging_put_LogOutgoing   10 int
#comfunc global IFaxActivityLogging_get_DatabasePath  11 var
#comfunc global IFaxActivityLogging_put_DatabasePath  12 wstr
#comfunc global IFaxActivityLogging_Refresh           13
#comfunc global IFaxActivityLogging_Save              14
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。