Função StrRetToBSTR (shlwapi.h)

  • Artigo

Aceita uma estrutura STRRET retornada por IShellFolder::GetDisplayNameOf que contém ou aponta para uma cadeia de caracteres e retorna essa cadeia de caracteres como um BSTR.

Sintaxe

LWSTDAPI StrRetToBSTR(
  [in, out] STRRET          *pstr,
  [in]      PCUITEMID_CHILD pidl,
  [out]     BSTR            *pbstr
);

Parâmetros

[in, out] pstr

Tipo: STRRET*

Um ponteiro para uma estrutura STRRET . Quando a função retorna, esse ponteiro é mais válido.

[in] pidl

Tipo: PCUITEMID_CHILD

Um ponteiro para um ITEMIDLIST que identifica exclusivamente um objeto de arquivo ou uma subpasta em relação à pasta pai. Esse valor pode ser NULL.

[out] pbstr

Tipo: BSTR*

Um ponteiro para uma variável do tipo BSTR que recebe a cadeia de caracteres convertida.

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 STRRET apontada por pstr for definido como STRRET_WSTR, o membro pOleStr dessa estrutura será liberado no retorno.

Requisitos

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

Confira também

IShellFolder::GetDisplayNameOf

StrRetToBuf

StrRetToStr