Função StrRetToStrW (shlwapi.h)

  • Artigo

Usa uma estrutura STRRET retornada por IShellFolder::GetDisplayNameOf e retorna um ponteiro para uma cadeia de caracteres alocada que contém o nome de exibição.

Sintaxe

LWSTDAPI StrRetToStrW(
  [in, out]      STRRET          *pstr,
  [in, optional] PCUITEMID_CHILD pidl,
  [out]          LPWSTR          *ppsz
);

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, optional] pidl

Tipo: PCUITEMID_CHILD

Um ponteiro para a estrutura ITEMIDLIST do item. Esse valor pode ser NULL.

[out] ppsz

Tipo: LPTSTR*

Um ponteiro para uma cadeia de caracteres alocada que contém o resultado. StrRetToStr aloca memória para essa cadeia de caracteres com CoTaskMemAlloc. Você deve liberar a cadeia de caracteres com CoTaskMemFree quando ela não for mais necessária.

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

Observação

O cabeçalho shlwapi.h define StrRetToStr 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

StrRetToBuf