Win32 API 日本語リファレンス
ホーム › Storage.FileServerResourceManager › IFsrmActionCommand

IFsrmActionCommand

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

公式ドキュメント

クォータ、ファイルスクリーン、またはファイル管理ジョブのイベントに応じて、コマンドまたはスクリプトを実行するために使用します。

メソッド 14

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

vtbl 12 HRESULT get_ExecutablePath(LPWSTR* executablePath)

実行する実行可能プログラムまたはスクリプトのフルパスを取得または設定します。(Get)

executablePathLPWSTR*out実行する実行可能ファイルのパス文字列を受け取るポインタである。

解説(Remarks)

パスは、プロパティを設定する時点とコマンドが実行される時点の両方で存在している必要があります。コマンドの実行時にパスが存在しない場合、FSRM はアプリケーション ログにイベントを書き込みます。

コマンドを実行するには、アクションを構成したユーザーが、コマンドの実行時点で Administrators グループに属している必要があります。

プロパティを設定する時点とコマンドが実行される時点の両方で、パス内のすべてのフォルダーに対する書き込みアクセス権は管理者のみが持つ必要があります。コマンドの実行時に他のユーザーが書き込みアクセス権を持っている場合、FSRM はコマンドを実行せず、アプリケーション ログにイベントを書き込みます。

vtbl 13 HRESULT put_ExecutablePath(LPWSTR executablePath)

実行する実行可能プログラムまたはスクリプトのフルパスを取得または設定します。(Put)

executablePathLPWSTRin設定する実行可能ファイルのパスを指定するポインタである。

解説(Remarks)

パスは、プロパティを設定する時点とコマンドが実行される時点の両方で存在している必要があります。コマンドの実行時にパスが存在しない場合、FSRM はアプリケーション ログにイベントを書き込みます。

コマンドを実行するには、アクションを構成したユーザーが、コマンドの実行時点で Administrators グループに属している必要があります。

プロパティを設定する時点とコマンドが実行される時点の両方で、パス内のすべてのフォルダーに対する書き込みアクセス権は管理者のみが持つ必要があります。コマンドの実行時に他のユーザーが書き込みアクセス権を持っている場合、FSRM はコマンドを実行せず、アプリケーション ログにイベントを書き込みます。

vtbl 14 HRESULT get_Arguments(LPWSTR* arguments)

ExecutablePath プロパティで指定された実行可能プログラムに渡す引数を取得または設定します。(Get)

argumentsLPWSTR*out実行時に渡すコマンドライン引数の文字列を受け取るポインタである。
vtbl 15 HRESULT put_Arguments(LPWSTR arguments)

ExecutablePath プロパティで指定された実行可能プログラムに渡す引数を取得または設定します。(Put)

argumentsLPWSTRin設定するコマンドライン引数を指定するポインタである。
vtbl 16 HRESULT get_Account(FsrmAccountType* account)

ExecutablePath プロパティで指定された実行可能プログラムの実行に使用されるシステム アカウントを取得または設定します。(Get)

accountFsrmAccountType*outコマンドを実行するアカウントの種類(FsrmAccountType)を受け取るポインタである。
vtbl 17 HRESULT put_Account(FsrmAccountType account)

ExecutablePath プロパティで指定された実行可能プログラムの実行に使用されるシステム アカウントを取得または設定します。(Put)

accountFsrmAccountTypeinコマンドを実行するアカウントの種類(FsrmAccountType)を指定する。
vtbl 18 HRESULT get_WorkingDirectory(LPWSTR* workingDirectory)

実行可能プログラムを実行する作業ディレクトリを取得または設定します。(Get)

workingDirectoryLPWSTR*outコマンド実行時の作業ディレクトリのパス文字列を受け取るポインタである。

解説(Remarks)

パスには環境変数を含めることができます。

パスは、プロパティを設定する時点またはコマンドが実行される時点で存在している必要があります。コマンドの実行時にパスが存在しない場合、FSRM はアプリケーション ログにイベントを書き込みます。

vtbl 19 HRESULT put_WorkingDirectory(LPWSTR workingDirectory)

実行可能プログラムを実行する作業ディレクトリを取得または設定します。(Put)

workingDirectoryLPWSTRin設定する作業ディレクトリのパスを指定するポインタである。

解説(Remarks)

パスには環境変数を含めることができます。

パスは、プロパティを設定する時点またはコマンドが実行される時点で存在している必要があります。コマンドの実行時にパスが存在しない場合、FSRM はアプリケーション ログにイベントを書き込みます。

vtbl 20 HRESULT get_MonitorCommand(VARIANT_BOOL* monitorCommand)

ExecutablePath プロパティで指定された実行可能プログラムを FSRM が監視するかどうかを決定する値を取得または設定します。(Get)

monitorCommandVARIANT_BOOL*outコマンドの実行を監視するかどうかを受け取る VARIANT_BOOL へのポインタである。

解説(Remarks)

このプロパティが VARIANT_TRUE に設定されていない場合、KillTimeOut プロパティと LogResult プロパティは無視されます。

vtbl 21 HRESULT put_MonitorCommand(VARIANT_BOOL monitorCommand)

ExecutablePath プロパティで指定された実行可能プログラムを FSRM が監視するかどうかを決定する値を取得または設定します。(Put)

monitorCommandVARIANT_BOOLinコマンドの実行を監視するかどうかを指定する VARIANT_BOOL である。

解説(Remarks)

このプロパティが VARIANT_TRUE に設定されていない場合、KillTimeOut プロパティと LogResult プロパティは無視されます。

vtbl 22 HRESULT get_KillTimeOut(INT* minutes)

ExecutablePath プロパティで指定された実行可能プログラムを実行しているプロセスを終了するまでに、サーバーが待機する時間 (分) を取得または設定します。(Get)

minutesINT*outコマンドを強制終了するまでのタイムアウトを分単位で受け取るポインタである。

解説(Remarks)

FSRM がプロセスを終了するには、IFsrmActionCommand::MonitorCommand プロパティが VARIANT_TRUE に設定されている必要があります。

vtbl 23 HRESULT put_KillTimeOut(INT minutes)

ExecutablePath プロパティで指定された実行可能プログラムを実行しているプロセスを終了するまでに、サーバーが待機する時間 (分) を取得または設定します。(Put)

minutesINTinコマンドを強制終了するまでのタイムアウトを分単位で指定する。

解説(Remarks)

FSRM がプロセスを終了するには、IFsrmActionCommand::MonitorCommand プロパティが VARIANT_TRUE に設定されている必要があります。

vtbl 24 HRESULT get_LogResult(VARIANT_BOOL* logResults)

実行可能プログラムの戻りコードを含むアプリケーション イベントを FSRM が記録するかどうかを決定する値を取得または設定します。(Get)

logResultsVARIANT_BOOL*outコマンドの実行結果をログに記録するかどうかを受け取る VARIANT_BOOL へのポインタである。

解説(Remarks)

FSRM がイベントを記録するには、IFsrmActionCommand::MonitorCommand プロパティが VARIANT_TRUE に設定されている必要があります。

vtbl 25 HRESULT put_LogResult(VARIANT_BOOL logResults)

実行可能プログラムの戻りコードを含むアプリケーション イベントを FSRM が記録するかどうかを決定する値を取得または設定します。(Put)

logResultsVARIANT_BOOLinコマンドの実行結果をログに記録するかどうかを指定する VARIANT_BOOL である。

解説(Remarks)

FSRM がイベントを記録するには、IFsrmActionCommand::MonitorCommand プロパティが VARIANT_TRUE に設定されている必要があります。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IFsrmActionCommand "{12937789-E247-4917-9C20-F3EE9C7EE783}"
#usecom global IFsrmActionCommand IID_IFsrmActionCommand "{}"
#comfunc global IFsrmActionCommand_get_ExecutablePath    12 var
#comfunc global IFsrmActionCommand_put_ExecutablePath    13 wstr
#comfunc global IFsrmActionCommand_get_Arguments         14 var
#comfunc global IFsrmActionCommand_put_Arguments         15 wstr
#comfunc global IFsrmActionCommand_get_Account           16 var
#comfunc global IFsrmActionCommand_put_Account           17 int
#comfunc global IFsrmActionCommand_get_WorkingDirectory  18 var
#comfunc global IFsrmActionCommand_put_WorkingDirectory  19 wstr
#comfunc global IFsrmActionCommand_get_MonitorCommand    20 var
#comfunc global IFsrmActionCommand_put_MonitorCommand    21 int
#comfunc global IFsrmActionCommand_get_KillTimeOut       22 var
#comfunc global IFsrmActionCommand_put_KillTimeOut       23 int
#comfunc global IFsrmActionCommand_get_LogResult         24 var
#comfunc global IFsrmActionCommand_put_LogResult         25 int
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。