ホーム › Storage.FileServerResourceManager › IFsrmQuotaBase

IFsrmQuotaBase

COMIDispatch (デュアル)

📘 Microsoft Learn (日本語) · English

✅ IDispatch を実装(デュアルインターフェース)。HSP では comobj 経由でメソッド名による遅延バインド呼び出しができます(vtableインデックス不要)。

IID1568a795-3924-4118-b74b-68d8f0fa5daf継承元IFsrmObject呼び出し名前(IDispatch) または vtbl自前メソッド開始 vtbl12

公式ドキュメント

すべてのクォータインターフェースの基底インターフェースです。

メソッド 10

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

vtbl 12 HRESULT get_QuotaLimit(VARIANT* quotaLimit)

オブジェクトのクォータ制限を取得または設定します。(Get)

quotaLimit

VARIANT*

out

クォータの上限値(バイト)を格納した VARIANT を受け取るポインタである。

解説(Remarks)

クォータ制限が強制されている場合、制限を超える IO 操作は失敗します。

例

例については、クォータの定義にテンプレートを使用するを参照してください。

vtbl 13 HRESULT put_QuotaLimit(VARIANT quotaLimit)

オブジェクトのクォータ制限を取得または設定します。(Put)

quotaLimit

VARIANT

設定するクォータの上限値(バイト)を格納した VARIANT である。

解説(Remarks)

クォータ制限が強制されている場合、制限を超える IO 操作は失敗します。

例

例については、クォータの定義にテンプレートを使用するを参照してください。

vtbl 14 HRESULT get_QuotaFlags(INT* quotaFlags)

オブジェクトのクォータフラグを取得または設定します。(Get)

quotaFlags

INT*

out

クォータの動作を表すフラグを受け取るポインタである。

vtbl 15 HRESULT put_QuotaFlags(INT quotaFlags)

オブジェクトのクォータフラグを取得または設定します。(Put)

quotaFlags

INT

設定するクォータの動作フラグを指定する。

vtbl 16 HRESULT get_Thresholds(SAFEARRAY** thresholds)

クォータオブジェクトのしきい値を取得します。

thresholds

SAFEARRAY**

out

設定されているしきい値(使用率パーセント)の一覧を表す SAFEARRAY を受け取るポインタである。

解説(Remarks)

しきい値を設定するには、 IFsrmQuotaBase::AddThreshold メソッドを呼び出します。

vtbl 17 HRESULT AddThreshold(INT threshold)

クォータオブジェクトにしきい値を追加します。

threshold

INT

クォータオブジェクトに追加するしきい値です。しきい値はクォータ制限に対する割合 (パーセント) で表されます。値は 1 以上 250 以下である必要があります。

戻り値

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

解説(Remarks)

1 つのクォータに対して、最大 16 個の一意なしきい値を指定できます。

しきい値は、使用されたディレクトリのクォータ制限の割合を整数で定義します。ディレクトリ内のすべてのデータのサイズがしきい値を超えると、FSRM サーバーは指定されたアクションを実行します ( IFsrmQuotaBase::CreateThresholdAction を参照)。

例

例については、クォータの定義にテンプレートを使用するを参照してください。

vtbl 18 HRESULT DeleteThreshold(INT threshold)

クォータオブジェクトからしきい値を削除します。

threshold

INT

削除するしきい値です。

戻り値

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

解説(Remarks)

そのしきい値に関連付けられているすべてのアクションも削除されます。ただし、アクションは IFsrmQuotaBase::Commit メソッドが呼び出されるまで削除されない点に注意してください。

vtbl 19 HRESULT ModifyThreshold(INT threshold, INT newThreshold)

しきい値を変更します。

threshold	INT	in	変更前のしきい値です。
newThreshold	INT	in	新しいしきい値です。値は 1 以上 250 以下である必要があります。

戻り値

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

vtbl 20 HRESULT CreateThresholdAction(INT threshold, FsrmActionType actionType, IFsrmAction** action)

アクションを作成し、指定したしきい値に関連付けます。

threshold	INT	in	アクションを関連付けるしきい値です。 IFsrmQuotaBase::AddThreshold メソッドを呼び出したときに指定した値と同じ値を指定します。
actionType	FsrmActionType	in	しきい値に達したとき、またはしきい値を超えたときに実行するアクションです。指定できる値については、 FsrmActionType 列挙型を参照してください。
action	IFsrmAction**	out	新しく作成されたアクションの IFsrmAction インターフェースです。actionType パラメーターで指定したアクションのインターフェースをクエリしてください。たとえば、アクションの種類が FsrmActionType_Command の場合は、 IFsrmActionCommand インターフェースをクエリします。

戻り値

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

解説(Remarks)

各しきい値に対して、最大 4 つの一意なアクションを指定できます。

しきい値が削除されると、そのアクションも削除されます。

例

例については、クォータの定義にテンプレートを使用するを参照してください。

vtbl 21 HRESULT EnumThresholdActions(INT threshold, IFsrmCollection** actions)

指定したしきい値に対するすべてのアクションを列挙します。

threshold	INT	in	列挙するアクションを含むしきい値です。
actions	IFsrmCollection**	out	アクションのコレクションを含む IFsrmCollection インターフェースです。コレクション内の各項目のバリアント型は VT_DISPATCH です。バリアントの pdispVal メンバーをクエリして IFsrmAction インターフェースを取得してください。実際にクエリすべきアクションインターフェースは、 IFsrmAction::ActionType プロパティを使用して判断できます。

戻り値

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IFsrmQuotaBase "{1568A795-3924-4118-B74B-68D8F0FA5DAF}"
#usecom global IFsrmQuotaBase IID_IFsrmQuotaBase "{}"
#comfunc global IFsrmQuotaBase_get_QuotaLimit         12 var
#comfunc global IFsrmQuotaBase_put_QuotaLimit         13 int
#comfunc global IFsrmQuotaBase_get_QuotaFlags         14 var
#comfunc global IFsrmQuotaBase_put_QuotaFlags         15 int
#comfunc global IFsrmQuotaBase_get_Thresholds         16 var
#comfunc global IFsrmQuotaBase_AddThreshold           17 int
#comfunc global IFsrmQuotaBase_DeleteThreshold        18 int
#comfunc global IFsrmQuotaBase_ModifyThreshold        19 int,int
#comfunc global IFsrmQuotaBase_CreateThresholdAction  20 int,int,sptr
#comfunc global IFsrmQuotaBase_EnumThresholdActions   21 int,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。#define global IID_IFsrmQuotaBase "{1568A795-3924-4118-B74B-68D8F0FA5DAF}"
#usecom global IFsrmQuotaBase IID_IFsrmQuotaBase "{}"
#comfunc global IFsrmQuotaBase_get_QuotaLimit         12 sptr
#comfunc global IFsrmQuotaBase_put_QuotaLimit         13 int
#comfunc global IFsrmQuotaBase_get_QuotaFlags         14 sptr
#comfunc global IFsrmQuotaBase_put_QuotaFlags         15 int
#comfunc global IFsrmQuotaBase_get_Thresholds         16 sptr
#comfunc global IFsrmQuotaBase_AddThreshold           17 int
#comfunc global IFsrmQuotaBase_DeleteThreshold        18 int
#comfunc global IFsrmQuotaBase_ModifyThreshold        19 int,int
#comfunc global IFsrmQuotaBase_CreateThresholdAction  20 int,int,sptr
#comfunc global IFsrmQuotaBase_EnumThresholdActions   21 int,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。