Partager via


StrRetToStrA, fonction (shlwapi.h)

Prend une structure STRRET retournée par IShellFolder ::GetDisplayNameOf et retourne un pointeur vers une chaîne allouée contenant le nom complet.

Syntaxe

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

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, optional] pidl

Type : PCUITEMID_CHILD

Pointeur vers la structure ITEMIDLIST de l’élément. Cette valeur peut être NULL.

[out] ppsz

Type : LPTSTR*

Pointeur vers une chaîne allouée contenant le résultat. StrRetToStr alloue de la mémoire pour cette chaîne avec CoTaskMemAlloc. Vous devez libérer la chaîne avec CoTaskMemFree quand elle n’est plus nécessaire.

Valeur de retour

Type : HRESULT

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

Remarques

Note

L’en-tête shlwapi.h définit StrRetToStr 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

StrRetToBuf