StrRetToStrW-Funktion (shlwapi.h)

  • Artikel

Verwendet eine STRRET-Struktur , die von IShellFolder::GetDisplayNameOf zurückgegeben wird, und gibt einen Zeiger auf eine zugeordnete Zeichenfolge zurück, die den Anzeigenamen enthält.

Syntax

LWSTDAPI StrRetToStrW(
  [in, out]      STRRET          *pstr,
  [in, optional] PCUITEMID_CHILD pidl,
  [out]          LPWSTR          *ppsz
);

Parameter

[in, out] pstr

Typ: STRRET*

Ein Zeiger auf die STRRET-Struktur . Wenn die Funktion zurückgegeben wird, ist dieser Zeiger nicht mehr gültig.

[in, optional] pidl

Typ: PCUITEMID_CHILD

Ein Zeiger auf die ITEMIDLIST-Struktur des Elements. Dieser Wert kann NULL sein.

[out] ppsz

Typ: LPTSTR*

Ein Zeiger auf eine zugeordnete Zeichenfolge, die das Ergebnis enthält. StrRetToStr weist Arbeitsspeicher für diese Zeichenfolge mit CoTaskMemAlloc zu. Sie sollten die Zeichenfolge mit CoTaskMemFree freigeben, wenn sie nicht mehr benötigt wird.

Rückgabewert

Typ: HRESULT

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

Hinweise

Hinweis

Der shlwapi.h-Header definiert StrRetToStr als Alias, der die ANSI- oder Unicode-Version dieser Funktion basierend auf der Definition der UNICODE-Präprozessorkonstante automatisch auswählt. Das Mischen der Verwendung des codierungsneutralen Alias mit Code, der nicht Codierungsneutral ist, kann zu Nichtübereinstimmungen führen, die zu Kompilierungs- oder Laufzeitfehlern führen. Weitere Informationen finden Sie unter Konventionen für Funktionsprototypen.

Anforderungen

Anforderung Wert
Unterstützte Mindestversion (Client) Windows 2000 Professional, Windows XP [nur Desktop-Apps]
Unterstützte Mindestversion (Server) Windows 2000 Server [nur Desktop-Apps]
Zielplattform Windows
Kopfzeile shlwapi.h
Bibliothek Shlwapi.lib
DLL Shlwapi.dll (Version 5.0 oder höher)

Weitere Informationen

StrRetToBuf