StrRetToBufA, fonction (shlwapi.h)

Article
11/20/2024

Convertit une structure STRRET retournée par IShellFolder ::GetDisplayNameOf en chaîne et place le résultat dans une mémoire tampon.

Syntaxe

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

Paramètres

[in, out] pstr

Type : STRRET*

Pointeur vers la structure STRRET. Lorsque la fonction est retournée, ce pointeur ne sera plus valide.

[in] pidl

Type : PCUITEMID_CHILD

Pointeur vers la structure ITEMIDLIST de l’élément.

[out] pszBuf

Type : LPTSTR

Mémoire tampon pour contenir le nom complet. Elle est retournée sous la forme d’une chaîne terminée par null. Si cchBuf est trop petit, le nom est tronqué pour s’adapter.

[in] cchBuf

Type : uiNT

Taille de pszBuf, en caractères. Si cchBuf est trop petit, la chaîne est tronquée pour s’adapter.

Valeur de retour

Type : HRESULT

Si cette fonction réussit, elle retourne S_OK. Sinon, elle retourne un HRESULT code d’erreur.

Remarques

Si le membre uType de la structure pointée par pstr est défini sur STRRET_WSTR, le membre pOleStr de cette structure sera libéré lors du retour.

Note

L’en-tête shlwapi.h définit StrRetToBuf comme alias qui sélectionne automatiquement la version ANSI ou Unicode de cette fonction en fonction de la définition de la constante de préprocesseur UNICODE. Le mélange de l’utilisation de l’alias neutre en encodage avec du code qui n’est pas neutre en encodage peut entraîner des incompatibilités qui entraînent des erreurs de compilation ou d’exécution. Pour plus d’informations, consultez Conventions pour les prototypes de fonction.

Exigences

Exigence	Valeur
client minimum pris en charge	Windows 2000 Professionnel, Windows XP [applications de bureau uniquement]
serveur minimum pris en charge	Windows 2000 Server [applications de bureau uniquement]
plateforme cible	Windows
d’en-tête	shlwapi.h
bibliothèque	Shlwapi.lib
DLL	Shlwapi.dll (version 5.0 ou ultérieure)

Voir aussi

StrRetToStr

strRetToStrN

Partager via