Freigeben über


StrRetToStrW-Funktion (shlwapi.h)

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 Speicher für diese Zeichenfolge mit CoTaskMemAlloczu. 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_OKzurückgegeben. Andernfalls wird ein HRESULT- Fehlercode zurückgegeben.

Bemerkungen

Anmerkung

Der Header "shlwapi.h" 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
mindestens unterstützte Client- Windows 2000 Professional, Windows XP [nur Desktop-Apps]
mindestens unterstützte Server- Windows 2000 Server [nur Desktop-Apps]
Zielplattform- Fenster
Header- shlwapi.h
Library Shlwapi.lib
DLL- Shlwapi.dll (Version 5.0 oder höher)

Siehe auch

StrRetToBuf-