Edit

IPropertyDescription::GetDisplayName method (propsys.h)

  • Article

Gets the display name of the property as it is shown in any UI.

Syntax

HRESULT GetDisplayName(
  [out] LPWSTR *ppszName
);

Parameters

[out] ppszName

Type: LPWSTR*

Contains the address of a pointer to the property's name as a null-terminated Unicode string.

Return value

Type: HRESULT

Returns one of the following values.

Return code Description
S_OK
 Display name is obtained.
E_INVALIDARG
 The ppszDisplayName parameter is NULL.
E_OUTOFMEMORY
 Memory allocation failed.

Remarks

The information retrieved by this method comes from the singularLabel and pluralLabel attributes of the labelInfo element in the property's .propdesc file.

It is the responsibility of the calling application to use CoTaskMemFree to release the string referred to by ppszDisplayName when it is no longer needed.

Requirements

Requirement Value
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2008 [desktop apps only]
Target Platform Windows
Header propsys.h

See also

IPropertyDescription

Property Description Schema