StrRetToBufA-Funktion (shlwapi.h)

  • Artikel

Konvertiert eine von IShellFolder::GetDisplayNameOf zurückgegebene STRRET-Struktur in eine Zeichenfolge und platziert das Ergebnis in einem Puffer.

Syntax

LWSTDAPI StrRetToBufA(
  [in, out] STRRET          *pstr,
  [in]      PCUITEMID_CHILD pidl,
  [out]     LPSTR           pszBuf,
  [in]      UINT            cchBuf
);

Parameter

[in, out] pstr

Typ: STRRET*

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

[in] pidl

Typ: PCUITEMID_CHILD

Ein Zeiger auf die ITEMIDLIST-Struktur des Elements.

[out] pszBuf

Typ: LPTSTR

Ein Puffer, der den Anzeigenamen enthält. Es wird als NULL-beendete Zeichenfolge zurückgegeben. Wenn cchBuf zu klein ist, wird der Name so abgeschnitten, dass er passt.

[in] cchBuf

Typ: UINT

Die Größe von pszBuf in Zeichen. Wenn cchBuf zu klein ist, wird die Zeichenfolge so abgeschnitten, dass sie passt.

Rückgabewert

Typ: HRESULT

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

Hinweise

Wenn das uType-Element der Struktur, auf die von pstr verwiesen wird, auf STRRET_WSTR festgelegt ist, wird das pOleStr-Element dieser Struktur bei der Rückgabe freigegeben.

Hinweis

Der shlwapi.h-Header definiert StrRetToBuf 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 nicht codierungsneutralem Code 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

StrRetToStr

StrRetToStrN