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

IFsrmAction

COMIDispatch (デュアル)
IDispatch を実装(デュアルインターフェース)。HSP では comobj 経由でメソッド名による遅延バインド呼び出しができます(vtableインデックス不要)。
IID6cd6408a-ae60-463b-9ef1-e117534d69dc継承元IDispatch呼び出し名前(IDispatch) または vtbl自前メソッド開始 vtbl7

公式ドキュメント

すべての FSRM アクション インターフェイスの基底クラスです。

解説(Remarks)

FSRM サーバーは、クォータまたはファイルスクリーンのイベント (たとえば、ディレクトリのサイズがディレクトリのクォータしきい値を超えた場合や、制限されたファイルが検出された場合) に応じてアクションを開始します。

メソッド 5

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

vtbl 7 HRESULT get_Id(GUID* id)

アクションの識別子を取得します。

idGUID*outアクションを一意に識別する ID(GUID)を受け取るポインタである。
vtbl 8 HRESULT get_ActionType(FsrmActionType* actionType)

アクションの種類を取得します。

actionTypeFsrmActionType*outアクションの種類(FsrmActionType)を受け取るポインタである。
vtbl 9 HRESULT get_RunLimitInterval(INT* minutes)

アクションを再度実行するまでに経過している必要がある間隔を取得または設定します。(Get)

minutesINT*outアクションの実行間隔の下限を分単位で受け取るポインタである。

解説(Remarks)

このプロパティは、アクションを再度実行するまでに経過すべき間隔を指定します。たとえば、アクションが最後に実行されてからこの間隔が経過している場合、サーバーはイベントに応じてアクションを再度実行します。経過していない場合、サーバーはアクションを再度実行できません。

間隔は次のように指定できます。

間隔 説明
–1 グローバルな実行時間の制限を使用します。説明については、 IFsrmSetting::SetActionRunLimitInterval メソッドを参照してください。
0 クォータまたはファイルスクリーンのイベントごとにアクションを実行します。
>0 この間隔の間にイベントが発生しても、アクションを再度実行しません。間隔のタイマーはアクションの開始時に始まります。 間隔が経過すると、タイマーはリセットされます。
vtbl 10 HRESULT put_RunLimitInterval(INT minutes)

アクションを再度実行するまでに経過している必要がある間隔を取得または設定します。(Put)

minutesINTinアクションの実行間隔の下限を分単位で指定する。

解説(Remarks)

このプロパティは、アクションを再度実行するまでに経過すべき間隔を指定します。たとえば、アクションが最後に実行されてからこの間隔が経過している場合、サーバーはイベントに応じてアクションを再度実行します。経過していない場合、サーバーはアクションを再度実行できません。

間隔は次のように指定できます。

間隔 説明
–1 グローバルな実行時間の制限を使用します。説明については、 IFsrmSetting::SetActionRunLimitInterval メソッドを参照してください。
0 クォータまたはファイルスクリーンのイベントごとにアクションを実行します。
>0 この間隔の間にイベントが発生しても、アクションを再度実行しません。間隔のタイマーはアクションの開始時に始まります。 間隔が経過すると、タイマーはリセットされます。
vtbl 11 HRESULT Delete()

クォータまたはファイルスクリーンのアクション一覧からアクションを削除します。

戻り値

このメソッドは次の戻り値を返します。

解説(Remarks)

IFsrmQuotaBase::DeleteThreshold メソッドを呼び出すと、 そのしきい値に関連付けられているアクションも削除されます。

アクションは、オブジェクトの Commit メソッドを呼び出すまでオブジェクトから削除されない点に注意してください。たとえば、IFsrmQuota::Commit メソッドが呼び出されるまでクォータからは削除されず、 IFsrmFileScreen::Commit メソッドを呼び出すまでファイルスクリーンからも削除されません。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IFsrmAction "{6CD6408A-AE60-463B-9EF1-E117534D69DC}"
#usecom global IFsrmAction IID_IFsrmAction "{}"
#comfunc global IFsrmAction_get_Id                7 var
#comfunc global IFsrmAction_get_ActionType        8 var
#comfunc global IFsrmAction_get_RunLimitInterval  9 var
#comfunc global IFsrmAction_put_RunLimitInterval  10 int
#comfunc global IFsrmAction_Delete                11
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。