ConfigureModule.ProvideTextData メソッド

ProvideTextData メソッドは、クライアント ツールからテキスト データを取得するために、Mergemod.dll によって呼び出されます。 Mergemod.dll により、ModuleConfiguration テーブル内の対応するエントリから Name が提供されます。

このツールによって S_OK が返され、ConfigData で適切なカスタマイズ テキストが提供されます。 クライアント ツールはデータの割り当てを担当しますが、Mergemod.dll はメモリの解放を担当します。 この引数は BSTR オブジェクトである必要があります。 LPCWSTR は受け入れられません。

この Name 値の構成データがツールによって提供されない場合、この関数では S_FALSE が返されます。 この場合、Mergemod.dllは ConfigData 引数の値を無視し、ModuleConfiguration テーブルの既定値を使用します。

S_OK または S_FALSE 以外のリターン コードを指定すると、エラーがログに記録され (ログが開いている場合)、マージが失敗します。

この関数は標準 の BSTR 規則に従っているため、null は空の文字列と同等です。

構文

ConfigureModule.ProvideTextData(
  Name,
  ConfigData
)

パラメーター

名前

データを取得するアイテムの名前。

ConfigData

カスタマイズ テキストへのポインター。

戻り値

このメソッドは値を返しません。

解説

クライアントは、ModuleConfiguration テーブルのレコードごとに 1 回だけ呼び出すことができます。 Mergemod.dll は、同じ "Name" 値に対してクライアントを複数回呼び出すことはないことに注意してください。 このプロパティを使用するレコードが ModuleSubstitution テーブル内にない場合、ModuleConfiguration テーブル内のエントリによるクライアントへの呼び出しは行われません。

C++

ProvideTextData 関数に関するページを参照してください。

必要条件

要件	値
バージョン	Mergemod.dll 2.0 以降
ヘッダー	Mergemod.h
[DLL]	Mergemod.dll