IShellLinkA::GetDescription メソッド (shobjidl_core.h)

シェル リンク オブジェクトの説明文字列を取得します。

構文

HRESULT GetDescription(
  LPSTR pszName,
  int   cch
);

パラメーター

pszName

種類: LPTSTR

説明文字列を受け取るバッファーへのポインター。

cch

型: int

pszName パラメーターが指すバッファーにコピーする最大文字数。

戻り値

種類: HRESULT

このメソッドは、成功すると S_OK を返します。 そうでない場合は、HRESULT エラー コードを返します。

注釈

Windows 2000 以降の場合、 pszName に返される文字列の最大長は INFOTIPSIZE です。 Windows 2000 より前のシステムでは、文字列のサイズはMAX_PATHによって制限されます。

要件

要件
サポートされている最小のクライアント Windows XP (デスクトップ アプリのみ)
サポートされている最小のサーバー Windows 2000 Server [デスクトップ アプリのみ]
対象プラットフォーム Windows
ヘッダー shobjidl_core.h
[DLL] Shell32.dll (バージョン 4.0 以降)