IPropertyDescription::GetDisplayName method

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

Syntax


HRESULT GetDisplayName(
  [out]  LPWSTR *ppszDisplayName
);

Parameters

ppszDisplayName [out]

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 codeDescription
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

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2008 [desktop apps only]

Header

Propsys.h

IDL

Propsys.idl

See also

IPropertyDescription
Property Description Schema

 

 

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.