Função StrRetToBufW (shlwapi.h)

Converte uma estrutura STRRET retornada por IShellFolder::GetDisplayNameOf em uma cadeia de caracteres e coloca o resultado em um buffer.

Sintaxe

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

Parâmetros

[in, out] pstr

Tipo: STRRET*

Um ponteiro para a estrutura STRRET . Quando a função retornar, esse ponteiro não será mais válido.

[in] pidl

Tipo: PCUITEMID_CHILD

Um ponteiro para a estrutura ITEMIDLIST do item.

[out] pszBuf

Tipo: LPTSTR

Um buffer para conter o nome de exibição. Ele será retornado como uma cadeia de caracteres terminada em nulo. Se cchBuf for muito pequeno, o nome será truncado para caber.

[in] cchBuf

Tipo: UINT

O tamanho do pszBuf, em caracteres. Se cchBuf for muito pequeno, a cadeia de caracteres será truncada para caber.

Retornar valor

Tipo: HRESULT

Se essa função for bem-sucedida, ela retornará S_OK. Caso contrário, ele retornará um código de erro HRESULT.

Comentários

Se o membro uType da estrutura apontada por pstr for definido como STRRET_WSTR, o membro pOleStr dessa estrutura será liberado no retorno.

Observação

O cabeçalho shlwapi.h define StrRetToBuf como um alias que seleciona automaticamente a versão ANSI ou Unicode dessa função com base na definição da constante de pré-processador UNICODE. Misturar o uso do alias neutro de codificação com código que não seja neutro em codificação pode levar a incompatibilidades que resultam em erros de compilação ou de runtime. Para obter mais informações, consulte Convenções para protótipos de função.

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Windows 2000 Professional, Windows XP [somente aplicativos da área de trabalho]
Servidor mínimo com suporte	Windows 2000 Server [somente aplicativos da área de trabalho]
Plataforma de Destino	Windows
Cabeçalho	shlwapi.h
Biblioteca	Shlwapi.lib
DLL	Shlwapi.dll (versão 5.0 ou posterior)

Confira também

StrRetToStr

StrRetToStrN