Función StrRetToBufA (shlwapi.h)

Convierte una estructura de de 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 se devuelve la función, este puntero ya no será válido.

[in] pidl

Tipo: PCUITEMID_CHILD

Puntero a la estructura ITEMIDLIST del elemento.

[out] pszBuf

Tipo: LPTSTR de

Búfer que contiene 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 ejecuta correctamente, devuelve S_OK. De lo contrario, devuelve un hrESULT código de error.

Observaciones

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

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

StrRetToStr

StrRetToStrN