Compartir a través de


Función StrRetToStrA (shlwapi.h)

Toma una estructura STRRET devuelta por IShellFolder::GetDisplayNameOf y devuelve un puntero a una cadena asignada que contiene el nombre para mostrar.

Sintaxis

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

Parámetros

[in, out] pstr

Tipo: STRRET*

Puntero a la estructura STRRET . Cuando la función vuelve, este puntero ya no será válido.

[in, optional] pidl

Tipo: PCUITEMID_CHILD

Puntero a la estructura ITEMIDLIST del elemento. Este valor puede ser NULL.

[out] ppsz

Tipo: LPTSTR*

Puntero a una cadena asignada que contiene el resultado. StrRetToStr asigna memoria para esta cadena con CoTaskMemAlloc. Debe liberar la cadena con CoTaskMemFree cuando ya no sea necesario.

Valor devuelto

Tipo: HRESULT

Si esta función se realiza correctamente, devuelve S_OK. De lo contrario, devuelve un código de error de HRESULT.

Comentarios

Nota

El encabezado shlwapi.h define StrRetToStr como alias que selecciona automáticamente la versión ANSI o Unicode de esta función en función de la definición de la constante de preprocesador UNICODE. La combinación del uso del alias neutro de codificación con código que no es neutral de codificación puede provocar discrepancias que dan lugar a errores de compilación o en tiempo de ejecución. Para obtener más información, vea Convenciones para prototipos de función.

Requisitos

Requisito Value
Cliente mínimo compatible Windows 2000 Professional, Windows XP [solo aplicaciones de escritorio]
Servidor mínimo compatible Windows 2000 Server [solo aplicaciones de escritorio]
Plataforma de destino Windows
Encabezado shlwapi.h
Library Shlwapi.lib
Archivo DLL Shlwapi.dll (versión 5.0 o posterior)

Consulte también

StrRetToBuf