Função StrRetToStrA (shlwapi.h)

Artigo
11/20/2024

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 StrRetToStrA(
  [in, out]      STRRET          *pstr,
  [in, optional] PCUITEMID_CHILD pidl,
  [out]          LPSTR           *ppsz
);

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

Tipo: PCUITEMID_CHILD

Um ponteiro para a estrutura de 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.

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

Nota

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 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

StrRetToBuf

Compartilhar via