IPropertyDescription::GetDisplayName-Methode (propsys.h)

  • Artikel

Ruft den Anzeigenamen der Eigenschaft ab, wie er auf einer beliebigen Benutzeroberfläche angezeigt wird.

Syntax

HRESULT GetDisplayName(
  [out] LPWSTR *ppszName
);

Parameter

[out] ppszName

Typ: LPWSTR*

Enthält die Adresse eines Zeigers auf den Namen der Eigenschaft als Unicode-Zeichenfolge mit NULL-Beendigung.

Rückgabewert

Typ: HRESULT

Gibt einen der folgenden Werte zurück.

Rückgabecode BESCHREIBUNG
S_OK
 Anzeigename wird abgerufen.
E_INVALIDARG
 Der ppszDisplayName-Parameter ist NULL.
E_OUTOFMEMORY
 Die Speicherbelegung hat einen Fehler erzeugt.

Hinweise

Die von dieser Methode abgerufenen Informationen stammen aus den Attributen singularLabel und pluralLabel des labelInfo-Elements in der PROPDESC-Datei der Eigenschaft.

Es liegt in der Verantwortung der aufrufenden Anwendung , CoTaskMemFree zu verwenden, um die von ppszDisplayName erwähnte Zeichenfolge freizugeben, wenn sie nicht mehr benötigt wird.

Anforderungen

   
Unterstützte Mindestversion (Client) Windows Vista [nur Desktop-Apps]
Unterstützte Mindestversion (Server) Windows Server 2008 [nur Desktop-Apps]
Zielplattform Windows
Kopfzeile propsys.h

Weitere Informationen

IPropertyDescription

Eigenschaftenbeschreibungsschema