Edit

IMsmError::get_Path method (mergemod.h)

  • Article

The get_Path method retrieves the Path property of the Error object.

Syntax

HRESULT get_Path(
  [out] BSTR *ErrorPath
);

Parameters

[out] ErrorPath

A pointer to a location in memory that is filled in with a BSTR value.

Return value

This method can return one of these values.

Value Meaning
E_INVALIDARG
 Path is null.
E_OUTOFMEMORY
 The system was unable to allocate memory for the string.
S_OK
 The function succeeded.

Remarks

The client is responsible for freeing the resulting string using SysFreeString.

In Windows Installer versions 1.0 and 1.1 get_Path always returns the empty string. Future versions of the class may use this function to return the path to the file or directory that could not be created. This value is only valid for errors of type msmErrorFileCreate or msmErrorDirCreate. You can determine the type of error by calling IMsmError::get_Type.

Requirements

Requirement Value
Minimum supported client Mergemod.dll 1.0 or later
Target Platform Windows
Header mergemod.h
DLL Mergemod.dll

See also

Merge Module Automation