IFsrmFileScreenTemplateManager
COMIDispatch (デュアル)comobj 経由でメソッド名による遅延バインド呼び出しができます(vtableインデックス不要)。公式ドキュメント
ファイルスクリーンテンプレートを管理するために使用します。
解説(Remarks)
オペレーティングシステムを新規インストールすると、FSRM で定義済みのテンプレートが含まれている点に注意してください。
スクリプトからこのオブジェクトを作成するには、"Fsrm.FsrmFileScreenTemplateManager" プログラム 識別子を使用します。
メソッド 5
vtbl = vtable インデックス(0始まり)。IDispatch 実装のため HSP ではメソッド名でも呼べます(上記)。低レベルの index 呼び出し用に vtbl も掲載。0〜2 は IUnknown。
ファイルスクリーンテンプレートオブジェクトを作成します。
| fileScreenTemplate | IFsrmFileScreenTemplate** | out | 新しく作成されたテンプレートへの IFsrmFileScreenTemplate インターフェイス。テンプレートを FSRM に追加するには、 IFsrmFileScreenTemplate::Commit メソッドを呼び出します。 |
戻り値
このメソッドは次の戻り値を返します。
指定したファイルスクリーンテンプレートを取得します。
| name | LPWSTR | in | 取得するファイルスクリーンテンプレートの名前。名前は 4,000 文字までに制限されます。 |
| fileScreenTemplate | IFsrmFileScreenTemplate** | out | 取得されたテンプレートへの IFsrmFileScreenTemplate インターフェイス。 |
戻り値
このメソッドは次の戻り値を返します。
サーバー上のファイルスクリーンテンプレートを列挙します。
| options | FsrmEnumOptions | in | ファイルスクリーンテンプレートを列挙する際に使用するオプション。指定できる値については、FsrmEnumOptions 列挙型を参照してください。 |
| fileScreenTemplates | IFsrmCommittableCollection** | out | ファイルスクリーンテンプレートのコレクションを格納する IFsrmCommittableCollection インターフェイス。 コレクションの各項目は VT_DISPATCH 型の VARIANT です。IFsrmFileScreenTemplate インターフェイスを取得するには、バリアントの pdispVal メンバーに対してクエリを実行します。 |
戻り値
このメソッドは次の戻り値を返します。
テンプレートを XML 文字列としてエクスポートします。
| fileScreenTemplateNamesArray | VARIANT* | in | エクスポートするファイルスクリーンテンプレートの名前を格納するバリアント。NULL の場合、このメソッドはすべてのファイルスクリーンをエクスポートします。 |
| serializedFileScreenTemplates | LPWSTR* | out | XML 形式で表された、指定したテンプレート。 |
戻り値
このメソッドは次の戻り値を返します。
解説(Remarks)
通常、このメソッドはテンプレートをファイルに保存するために使用します。その後、そのファイルを別のコンピューターにコピーし、IFsrmFileScreenTemplateManager::ImportTemplates メソッドを呼び出してテンプレートをインポートできます。
指定したファイルスクリーンテンプレートを XML 文字列からインポートします。
| serializedFileScreenTemplates | LPWSTR | in | 1 つ以上のファイルスクリーンテンプレートを表す XML 文字列。 |
| fileScreenTemplateNamesArray | VARIANT* | in | インポートするテンプレートの名前の SAFEARRAY を格納する VARIANT。NULL の場合、このメソッドはすべてのテンプレートをインポートします。 |
| fileScreenTemplates | IFsrmCommittableCollection** | out | ファイルスクリーンテンプレートのコレクションを格納する IFsrmCommittableCollection インターフェイス。 コレクションの各項目は VT_DISPATCH 型の VARIANT です。IFsrmFileScreenTemplateImported インターフェイスを取得するには、バリアントの pdispVal メンバーに対してクエリを実行します。 テンプレートを FSRM に追加するには、IFsrmCommittableCollection::Commit メソッドを呼び出します。テンプレートを FSRM に追加し、そのテンプレートから派生したオブジェクトに変更を反映させるには、コレクション内の各項目に対して IFsrmFileScreenTemplateImported::CommitAndUpdateDerived メソッドを呼び出します。 |
戻り値
このメソッドは次の戻り値を返します。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
HSP用 COM定義
#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。
#define global IID_IFsrmFileScreenTemplateManager "{CFE36CBA-1949-4E74-A14F-F1D580CEAF13}" #usecom global IFsrmFileScreenTemplateManager IID_IFsrmFileScreenTemplateManager "{243111DF-E474-46AA-A054-EAA33EDC292A}" #comfunc global IFsrmFileScreenTemplateManager_CreateTemplate 7 sptr #comfunc global IFsrmFileScreenTemplateManager_GetTemplate 8 wstr,sptr #comfunc global IFsrmFileScreenTemplateManager_EnumTemplates 9 int,sptr #comfunc global IFsrmFileScreenTemplateManager_ExportTemplates 10 var,var #comfunc global IFsrmFileScreenTemplateManager_ImportTemplates 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_IFsrmFileScreenTemplateManager "{CFE36CBA-1949-4E74-A14F-F1D580CEAF13}" #usecom global IFsrmFileScreenTemplateManager IID_IFsrmFileScreenTemplateManager "{243111DF-E474-46AA-A054-EAA33EDC292A}" #comfunc global IFsrmFileScreenTemplateManager_CreateTemplate 7 sptr #comfunc global IFsrmFileScreenTemplateManager_GetTemplate 8 wstr,sptr #comfunc global IFsrmFileScreenTemplateManager_EnumTemplates 9 int,sptr #comfunc global IFsrmFileScreenTemplateManager_ExportTemplates 10 sptr,sptr #comfunc global IFsrmFileScreenTemplateManager_ImportTemplates 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 不要)。