IShellLinkA::GetDescription-Methode (shobjidl_core.h)

Ruft die Beschreibungszeichenfolge für ein Shell-Linkobjekt ab.

Syntax

HRESULT GetDescription(
  LPSTR pszName,
  int   cch
);

Parameter

pszName

Typ: LPTSTR

Ein Zeiger auf den Puffer, der die Beschreibungszeichenfolge empfängt.

cch

Typ: int

Die maximale Anzahl von Zeichen, die in den Puffer kopiert werden sollen, auf den der parameter pszName verweist.

Rückgabewert

Typ: HRESULT

Wenn diese Methode erfolgreich ist, wird S_OK zurückgegeben. Andernfalls wird ein Fehlercode HRESULT zurückgegeben.

Hinweise

Für Windows 2000 oder höher weist die an pszName zurückgegebene Zeichenfolge eine maximale Länge von INFOTIPSIZE auf. Bei Systemen vor Windows 2000 ist die Größe der Zeichenfolge durch MAX_PATH begrenzt.

Anforderungen

Anforderung Wert
Unterstützte Mindestversion (Client) Windows XP [nur Desktop-Apps]
Unterstützte Mindestversion (Server) Windows 2000 Server [nur Desktop-Apps]
Zielplattform Windows
Kopfzeile shobjidl_core.h
DLL Shell32.dll (Version 4.0 oder höher)