IQueryInfo::GetInfoTip メソッド (shlobj_core.h)

項目のヒント テキストを取得します。

構文

HRESULT GetInfoTip(
        DWORD dwFlags,
  [out] PWSTR *ppwszTip
);

パラメーター

dwFlags

型: DWORD

ヒント テキストを取得するアイテムの処理を指示するフラグ。 この値は通常 0 (QITIPF_DEFAULT) です。 次の値が認識されます。

QITIPF_DEFAULT (0x00000000)

特別な処理はありません。

QITIPF_USENAME (0x00000001)

ヒント テキストではなく ppwszTip で項目の名前を指定します。

QITIPF_LINKNOTARGET (0x00000002)

アイテムがショートカットの場合は、ターゲットではなくショートカットのヒント テキストを取得します。

QITIPF_LINKUSETARGET (0x00000004)

アイテムがショートカットの場合は、ショートカットのターゲットのヒント テキストを取得します。

QITIPF_USESLOWTIP (0x00000008)

名前空間全体で情報を検索します。 この値を指定すると、応答時間が遅れる可能性があります。

QITIPF_SINGLELINE (0x00000010)

Windows Vista 以降。 情報ヒントを 1 行に配置します。

[out] ppwszTip

種類: PWSTR*

このメソッドが正常に返されたときにヒント文字列ポインターを受け取る Unicode 文字列ポインターのアドレス。 このメソッドを実装するアプリケーションでは、CoTaskMemAlloc を呼び出して ppwszTip のメモリを割り当てる必要があります。 呼び出し元のアプリケーションでは、不要になったときにメモリを解放するために CoTaskMemFree を呼び出す必要があります。

戻り値

型: HRESULT

関数が成功した場合S_OKを返します。 ヒント テキストが使用できない場合、 ppwszTip は NULL に設定されます。 それ以外の場合は、COM 定義のエラー値を返します。

要件

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

こちらもご覧ください

IQueryInfo