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

Obtiene la cadena de descripción de un objeto de vínculo de Shell.

Sintaxis

HRESULT GetDescription(
  LPSTR pszName,
  int   cch
);

Parámetros

pszName

Tipo: LPTSTR

Puntero al búfer que recibe la cadena de descripción.

cch

Tipo: int

Número máximo de caracteres que se van a copiar en el búfer al que apunta el parámetro pszName .

Valor devuelto

Tipo: HRESULT

Si este método se realiza correctamente, devuelve S_OK. De lo contrario, devuelve un código de error de HRESULT.

Comentarios

Para Windows 2000 o posterior, la cadena devuelta a pszName tiene una longitud máxima de INFOTIPSIZE. En el caso de los sistemas anteriores a Windows 2000, el tamaño de la cadena está limitado por MAX_PATH.

Requisitos

Requisito Value
Cliente mínimo compatible Windows XP [solo aplicaciones de escritorio]
Servidor mínimo compatible Windows 2000 Server [solo aplicaciones de escritorio]
Plataforma de destino Windows
Encabezado shobjidl_core.h
Archivo DLL Shell32.dll (versión 4.0 o posterior)