Compartir a través de


Función StrRetToStrA (shlwapi.h)

Toma una estructura de 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 se devuelve la función, 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 ejecuta correctamente, devuelve S_OK. De lo contrario, devuelve un hrESULT código de error.

Observaciones

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 neutral de codificación con código que no es neutral de codificación puede dar lugar a errores de coincidencia que dan lugar a errores de compilación o tiempo de ejecución. Para obtener más información, vea Conventions for Function Prototypes.

Requisitos

Requisito Valor
cliente mínimo admitido Windows 2000 Professional, Windows XP [solo aplicaciones de escritorio]
servidor mínimo admitido Windows 2000 Server [solo aplicaciones de escritorio]
de la plataforma de destino de Windows
encabezado de shlwapi.h
biblioteca de Shlwapi.lib
DLL de Shlwapi.dll (versión 5.0 o posterior)

Consulte también

StrRetToBuf