ホーム › Storage.FileServerResourceManager › IFsrmFileGroupManager

IFsrmFileGroupManager

COMIDispatch (デュアル)

📘 Microsoft Learn (日本語) · English

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

IID426677d5-018c-485c-8a51-20b86d00bdc4継承元IDispatch呼び出し名前(IDispatch) または vtbl自前メソッド開始 vtbl7

公式ドキュメント

ファイルグループオブジェクトを管理するために使用します。

解説(Remarks)

FSRM では次のグループが定義されています。

Audio and Video Files (オーディオおよびビデオファイル)
Backup Files (バックアップファイル)
Compressed Files (圧縮ファイル)
Email Files (電子メールファイル)
Executable Files (実行可能ファイル)
Image Files (イメージファイル)
Office Files (Office ファイル)
System Files (システムファイル)
Temporary Files (一時ファイル)
Text Files (テキストファイル)
Webpage Files (Web ページファイル)

スクリプトからこのオブジェクトを作成するには、"Fsrm.FsrmFileGroupManager" プログラム識別子を使用します。

メソッド 5

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

vtbl 7 HRESULT CreateFileGroup(IFsrmFileGroup** fileGroup)

ファイルグループオブジェクトを作成します。

fileGroup

IFsrmFileGroup**

out

新しいファイルグループへの IFsrmFileGroup インターフェイスです。ファイルグループを FSRM に追加するには、 IFsrmFileGroup::Commit メソッドを呼び出します。

戻り値

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

vtbl 8 HRESULT GetFileGroup(LPWSTR name, IFsrmFileGroup** fileGroup)

指定したファイルグループを FSRM から取得します。

name	LPWSTR	in	取得するファイルグループの名前です。この文字列は 4,000 文字までに制限されます。
fileGroup	IFsrmFileGroup**	out	取得されたファイルグループへの IFsrmFileGroup インターフェイスです。

戻り値

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

vtbl 9 HRESULT EnumFileGroups(FsrmEnumOptions options, IFsrmCommittableCollection** fileGroups)

FSRM 内のファイルグループを列挙します。

options

FsrmEnumOptions

ファイルグループを列挙するための 1 つ以上のオプションです。指定できる値については、 FsrmEnumOptions 列挙型を参照してください。

fileGroups

IFsrmCommittableCollection**

out

ファイルグループのコレクションを格納する IFsrmCommittableCollection インターフェイスです。コレクションの各項目は VT_DISPATCH 型の VARIANT です。IFsrmFileGroup インターフェイスを取得するには、バリアントの pdispVal メンバーに対してクエリを実行します。

このコレクションにはコミット済みのファイルグループのみが含まれます。コミットされていない新規作成のファイルグループはコレクションに含まれません。

戻り値

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

vtbl 10 HRESULT ExportFileGroups(VARIANT* fileGroupNamesArray, LPWSTR* serializedFileGroups)

指定したファイルグループを XML 文字列としてエクスポートします。

fileGroupNamesArray	VARIANT*	in	エクスポートするファイルグループの名前の SAFEARRAY を格納する VARIANT です。NULL の場合、このメソッドはすべてのファイルグループをエクスポートします。
serializedFileGroups	LPWSTR*	out	XML 形式で表された、指定されたファイルグループです。

戻り値

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

解説(Remarks)

通常、このメソッドはファイルグループの情報をファイルに保存するために使用します。その後、そのファイルを別のコンピューターにコピーし、 IFsrmFileGroupManager::ImportFileGroups メソッドを呼び出してファイルグループをインポートできます。

vtbl 11 HRESULT ImportFileGroups(LPWSTR serializedFileGroups, VARIANT* fileGroupNamesArray, IFsrmCommittableCollection** fileGroups)

指定したファイルグループを XML 文字列からインポートします。

serializedFileGroups

LPWSTR

1 つ以上のファイルグループを表す XML 文字列です。

fileGroupNamesArray

VARIANT*

インポートするファイルグループの名前の SAFEARRAY を格納する VARIANT です。NULL の場合、このメソッドはすべてのファイルグループをインポートします。

fileGroups

IFsrmCommittableCollection**

out

ファイルグループのコレクションを格納する IFsrmCommittableCollection インターフェイスです。

コレクションの各項目は VT_DISPATCH 型の VARIANT です。IFsrmFileGroupImported インターフェイスを取得するには、バリアントの pdispVal メンバーに対してクエリを実行します。

ファイルグループを FSRM に追加するには、 IFsrmCommittableCollection::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_IFsrmFileGroupManager "{426677D5-018C-485C-8A51-20B86D00BDC4}"
#usecom global IFsrmFileGroupManager IID_IFsrmFileGroupManager "{8F1363F6-656F-4496-9226-13AECBD7718F}"
#comfunc global IFsrmFileGroupManager_CreateFileGroup   7 sptr
#comfunc global IFsrmFileGroupManager_GetFileGroup      8 wstr,sptr
#comfunc global IFsrmFileGroupManager_EnumFileGroups    9 int,sptr
#comfunc global IFsrmFileGroupManager_ExportFileGroups  10 var,var
#comfunc global IFsrmFileGroupManager_ImportFileGroups  11 wstr,var,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※#usecom 末尾は CoCreateInstance 用のクラスID(コクラスCLSID, SDKから自動取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。#define global IID_IFsrmFileGroupManager "{426677D5-018C-485C-8A51-20B86D00BDC4}"
#usecom global IFsrmFileGroupManager IID_IFsrmFileGroupManager "{8F1363F6-656F-4496-9226-13AECBD7718F}"
#comfunc global IFsrmFileGroupManager_CreateFileGroup   7 sptr
#comfunc global IFsrmFileGroupManager_GetFileGroup      8 wstr,sptr
#comfunc global IFsrmFileGroupManager_EnumFileGroups    9 int,sptr
#comfunc global IFsrmFileGroupManager_ExportFileGroups  10 sptr,sptr
#comfunc global IFsrmFileGroupManager_ImportFileGroups  11 wstr,sptr,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※#usecom 末尾は CoCreateInstance 用のクラスID(コクラスCLSID, SDKから自動取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。