ホーム › Storage.FileServerResourceManager › IFsrmFileScreenTemplate

IFsrmFileScreenTemplate

COMIDispatch (デュアル)

📘 Microsoft Learn (日本語) · English

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

IID205bebf8-dd93-452a-95a6-32b566b35828継承元IFsrmFileScreenBase呼び出し名前(IDispatch) または vtbl自前メソッド開始 vtbl18

公式ドキュメント

新しいファイルスクリーンの派生元となるテンプレートを構成するために使用します。

メソッド 4

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

vtbl 18 HRESULT get_Name(LPWSTR* name)

ファイルスクリーンテンプレートの名前を取得および設定します。(Get)

name

LPWSTR*

out

ファイルスクリーンテンプレートの名前を受け取る文字列ポインタである。

解説(Remarks)

指定した名前のテンプレートが既に存在する場合、 IFsrmFileScreen::Commit メソッドを呼び出したときに、テンプレートは FSRM_E_ALREADY_EXISTS で失敗します。

例

例については、 Using Templates to Define File Screens を参照してください。

vtbl 19 HRESULT put_Name(LPWSTR name)

ファイルスクリーンテンプレートの名前を取得および設定します。(Put)

name

LPWSTR

ファイルスクリーンテンプレートに設定する名前を指定する文字列である。

解説(Remarks)

例

例については、 Using Templates to Define File Screens を参照してください。

vtbl 20 HRESULT CopyTemplate(LPWSTR fileScreenTemplateName)

指定したテンプレートのプロパティ値をこのテンプレートにコピーします。(IFsrmFileScreenTemplate.CopyTemplate)

fileScreenTemplateName

LPWSTR

プロパティ値のコピー元となる別のテンプレートの名前。名前は 4,000 文字までに制限されます。

戻り値

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

vtbl 21 HRESULT CommitAndUpdateDerived(FsrmCommitOptions commitOptions, FsrmTemplateApplyOptions applyOptions, IFsrmDerivedObjectsResult** derivedObjectsResult)

ファイルスクリーンテンプレートを保存し、派生したファイルスクリーンオブジェクトに変更を適用します。

commitOptions	FsrmCommitOptions	in	テンプレートを保存する際のオプション。指定できる値については、 FsrmCommitOptions 列挙型を参照してください。
applyOptions	FsrmTemplateApplyOptions	in	変更の適用先となる派生オブジェクトを選択するために使用するオプション。指定できる値については、 FsrmTemplateApplyOptions 列挙型を参照してください。
derivedObjectsResult	IFsrmDerivedObjectsResult**	out	更新された派生オブジェクトの一覧と、更新が成功したかどうかを判断するために使用する IFsrmDerivedObjectsResult インターフェース。

戻り値

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IFsrmFileScreenTemplate "{205BEBF8-DD93-452A-95A6-32B566B35828}"
#usecom global IFsrmFileScreenTemplate IID_IFsrmFileScreenTemplate "{}"
#comfunc global IFsrmFileScreenTemplate_get_Name                18 var
#comfunc global IFsrmFileScreenTemplate_put_Name                19 wstr
#comfunc global IFsrmFileScreenTemplate_CopyTemplate            20 wstr
#comfunc global IFsrmFileScreenTemplate_CommitAndUpdateDerived  21 int,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_IFsrmFileScreenTemplate "{205BEBF8-DD93-452A-95A6-32B566B35828}"
#usecom global IFsrmFileScreenTemplate IID_IFsrmFileScreenTemplate "{}"
#comfunc global IFsrmFileScreenTemplate_get_Name                18 sptr
#comfunc global IFsrmFileScreenTemplate_put_Name                19 wstr
#comfunc global IFsrmFileScreenTemplate_CopyTemplate            20 wstr
#comfunc global IFsrmFileScreenTemplate_CommitAndUpdateDerived  21 int,int,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。