IShellLinkA::GetDescription method

Gets the description string for a Shell link object.

Syntax

HRESULT GetDescription(
  LPSTR pszName,
  int   cch
);

Parameters

pszName

Type: LPTSTR

A pointer to the buffer that receives the description string.

cch

Type: int

The maximum number of characters to copy to the buffer pointed to by the pszName parameter.

Return Value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

For Windows 2000 or later, the string returned to pszName has a maximum length of INFOTIPSIZE. For systems prior to Windows 2000, the size of the string is limited by MAX_PATH.

Requirements

   
Minimum supported client Windows XP [desktop apps only]
Minimum supported server Windows 2000 Server [desktop apps only]
Target Platform Windows
Header shobjidl_core.h
DLL Shell32.dll (version 4.0 or later)