IPropertyDescription::GetCanonicalName-Methode (propsys.h)

Ruft den Namen ab, bei dem eine Eigenschaft dem System bekannt ist, unabhängig vom lokalisierten Namen.

Syntax

HRESULT GetCanonicalName(
  [out] LPWSTR *ppszName
);

Parameter

[out] ppszName

Typ: LPWSTR*

Wenn diese Methode zurückgibt, enthält die Adresse eines Zeigers auf den kanonischen Namen der Eigenschaft als null-beendete Unicode-Zeichenfolge.

Rückgabewert

Typ: HRESULT

Wenn diese Methode erfolgreich ist, wird S_OK zurückgegeben. Andernfalls wird ein Fehlercode HRESULT zurückgegeben.

Hinweise

Die von dieser Methode abgerufenen Informationen stammen aus dem name-Attribut des propertyDescription-Elements in der PROPDESC-Datei der Eigenschaft.

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

Anforderungen

Anforderung	Wert
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