Función StrRetToBufA (shlwapi.h)

Convierte una estructura STRRET devuelta por IShellFolder::GetDisplayNameOf en una cadena y coloca el resultado en un búfer.

Sintaxis

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

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

Tipo: PCUITEMID_CHILD

Puntero a la estructura ITEMIDLIST del elemento.

[out] pszBuf

Tipo: LPTSTR

Búfer que contendrá el nombre para mostrar. Se devolverá como una cadena terminada en null. Si cchBuf es demasiado pequeño, el nombre se truncará para ajustarse.

[in] cchBuf

Tipo: UINT

Tamaño de pszBuf, en caracteres. Si cchBuf es demasiado pequeño, la cadena se truncará para ajustarse.

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

Si el miembro uType de la estructura a la que apunta pstr se establece en STRRET_WSTR, el miembro pOleStr de esa estructura se liberará de vuelta.

Nota

El encabezado shlwapi.h define StrRetToBuf 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

StrRetToStr

StrRetToStrN