Método IShellLinkA::GetDescription (shobjidl_core.h)

  • Artigo

Obtém a cadeia de caracteres de descrição de um objeto de link do Shell.

Sintaxe

HRESULT GetDescription(
  LPSTR pszName,
  int   cch
);

Parâmetros

pszName

Tipo: LPTSTR

Um ponteiro para o buffer que recebe a cadeia de caracteres de descrição.

cch

Tipo: int

O número máximo de caracteres a serem copiados para o buffer apontado pelo parâmetro pszName .

Retornar valor

Tipo: HRESULT

Se o método for bem-sucedido, ele retornará S_OK. Caso contrário, ele retornará um código de erro HRESULT.

Comentários

Para o Windows 2000 ou posterior, a cadeia de caracteres retornada para pszName tem um comprimento máximo de INFOTIPSIZE. Para sistemas anteriores ao Windows 2000, o tamanho da cadeia de caracteres é limitado por MAX_PATH.

Requisitos

Requisito Valor
Cliente mínimo com suporte 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 shobjidl_core.h
DLL Shell32.dll (versão 4.0 ou posterior)