Edit

Share via

IMsmConfigurableItem::get_Description method (mergemod.h)

  • Article

The get_Description method retrieves the Description property of the ConfigurableItem object.

Syntax

HRESULT get_Description(
  [out] BSTR *Description
);

Parameters

[out] Description

A pointer to a location in memory with the description of a configurable item listed in the Description column of the ModuleConfiguration table. The client must free the BSTR when it is no longer needed.

Return value

This method can return one of these values.

Value Meaning
E_INVALIDARG
 Invalid argument.
S_OK
 The function succeeded.
E_FAIL
 No module is open.
E_OUTOFMEMORY
 Out of memory.
ERROR_FUNCTION_FAILED as HRESULT
 The function failed.
ERROR_INVALID_HANDLE as HRESULT
 The function failed.

Requirements

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

See also

IMsmConfigurableItem

Merge Module Automation