IPropertyUI::GetDisplayName method (shobjidl_core.h)

2021-10-13

Developers should use IPropertyDescription instead. Gets a string specifying the name of the property suitable for display to users.

Syntax

HRESULT GetDisplayName(
  [in]  REFFMTID              fmtid,
  [in]  PROPID                pid,
  [in]  PROPERTYUI_NAME_FLAGS flags,
  [out] LPWSTR                pwszText,
  [in]  DWORD                 cchText
);

Parameters

[in] fmtid

Type: REFFMTID

The FMTID of the property.

[in] pid

Type: PROPID

The PROPID of the property.

[in] flags

Type: PROPERTYUI_NAME_FLAGS

One of the following PROPERTYUI_NAME_FLAGS values:

PUIFNF_DEFAULT (0x00000000)

0x00000000.

PUIFNF_MNEMONIC (0x00000001)

0x00000001. Include mnemonic in display name.

[out] pwszText

Type: LPWSTR

A string specifying the property.

[in] cchText

Type: DWORD

The length of the property display name.

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Target Platform	Windows
Header	shobjidl_core.h