Compartilhar via


Função StrRetToStrN

Usa uma estrutura STRRET retornada por IShellFolder::GetDisplayNameOf, converte-a em uma cadeia de caracteres e coloca o resultado em um buffer.

Sintaxe

BOOL StrRetToStrN(
  _Out_   LPTSTR        pszOut,
  _In_    UINT          cchOut,
  _Inout_ LPSTRRET      pStrRet,
  _In_    LPCITEMIDLIST pidl
);

Parâmetros

pszOut [out]

Tipo: LPTSTR

Buffer para manter o nome de exibição. Ele será retornado como uma cadeia de caracteres terminada em nulo. Se cchOut for muito pequeno, o nome será truncado para caber.

cchOut [in]

Tipo: UINT

Tamanho do pszOut, em caracteres. Se cchOut for muito pequeno, a cadeia de caracteres será truncada para caber.

pStrRet [in, out]

Tipo: LPSTRRET

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

pidl [in]

Tipo: LPCITEMIDLIST

Ponteiro para a estrutura ITEMIDLIST do item.

Valor retornado

Tipo: BOOL

TRUE para êxito, FALSE para falha.

Comentários

Observação

A partir de Shell32.dll versão 5.0, chamar essa função é equivalente a chamar StrRetToBuf.

 

StrRetToStrN não é exportado por nome. Para usá-lo, você deve usar GetProcAddress e solicitar o ordinal 96 de Shell32.dll para obter um ponteiro de função.

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

Observe que essa função é exportada de Shell32.dll em vez de Shlwapi.dll. Também está incluído em Shlobj.h em vez de Shlwapi.h.

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]
DLL
Shell32.dll (versão 4.71 ou posterior)

Confira também

StrRetToStr

StrRetToBuf