ConfigureModule.ProvideTextData method

The ProvideTextData method is called by Mergemod.dll to retrieve text data from the client tool. Mergemod.dll provides the Name from the corresponding entry in the ModuleConfiguration table.

The tool should return S_OK and provide the appropriate customization text in ConfigData. The client tool is responsible for allocating the data, but Mergemod.dllis responsible for releasing the memory. This argument MUST be a BSTR object. LPCWSTR is NOT accepted.

If the tool does not provide any configuration data for this Name value, the function should return S_FALSE. In this case Mergemod.dll ignores the value of the ConfigData argument and uses the Default value from the ModuleConfiguration table.

Any return code other than S_OK or S_FALSE will cause an error to be logged (if a log is open) and will result in the merge failing.

Because this function follows standard BSTR convention, null is equivalent to the empty string.

Syntax

ConfigureModule.ProvideTextData(
  Name,
  ConfigData
)

Parameters

Name

Name of item for which data is being retrieved.

ConfigData

Pointer to customization text.

Return value

This method does not return a value.

Remarks

The client may be called no more than once for each record in the ModuleConfiguration table. Note that Mergemod.dll never makes multiple calls to the client for the same "Name" value. If no record in the ModuleSubstitution table uses the property, an entry in the ModuleConfiguration table causes no calls to the client.

C++

See ProvideTextData function.

Requirements