Função StrRetToBufA (shlwapi.h)

Artigo
11/20/2024

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

Sintaxe

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

Parâmetros

[in, out] pstr

Tipo: * STRRET

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

[in] pidl

Tipo: PCUITEMID_CHILD

Um ponteiro para a estrutura de ITEMIDLIST do item.

[out] pszBuf

Tipo: LPTSTR

Um buffer para manter o nome de exibição. Ela será retornada 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 de pszBuf, em caracteres. Se cchBuf for muito pequena, a cadeia de caracteres será truncada para caber.

Valor de retorno

Tipo: HRESULT

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

Observações

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

Nota

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 do pré-processador UNICODE. A combinação do uso do alias neutro de codificação com código que não é neutro em codificação pode levar a incompatibilidades que resultam em erros de compilação ou de runtime. Para obter mais informações, consulte Conventions for Function Prototypes.

Requisitos

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

Consulte também

StrRetToStr

StrRetToStrN

Compartilhar via