Share via

StrRetToBufA, fonction (shlwapi.h)

  • Article

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 retourne, ce pointeur n’est 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 d’affichage. Elle est retournée sous la forme d’une chaîne terminée par un caractère Null. Si cchBuf est trop petit, le nom est tronqué pour tenir.

[in] cchBuf

Type : UINT

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

Valeur retournée

Type : HRESULT

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

Remarques

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

Notes

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. La combinaison 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.

Configuration requise

Condition requise Valeur
Client minimal pris en charge Windows 2000 Professionnel, Windows XP [applications de bureau uniquement]
Serveur minimal pris en charge Windows 2000 Server [applications de bureau uniquement]
Plateforme cible Windows
En-tête shlwapi.h
Bibliothèque Shlwapi.lib
DLL Shlwapi.dll (version 5.0 ou ultérieure)

Voir aussi

StrRetToStr

StrRetToStrN