Edit

INameSpaceTreeControlEvents::OnGetToolTip method (shobjidl.h)

  • Article

Enables you to provide a tooltip.

Syntax

HRESULT OnGetToolTip(
  [in]  IShellItem *psi,
  [out] LPWSTR     pszTip,
  [in]  int        cchTip
);

Parameters

[in] psi

Type: IShellItem*

Pointer to the IShellItem that contains the tooltip.

[out] pszTip

Type: LPWSTR

When this method returns, contains the text of the tooltip.

[in] cchTip

Type: int

The size of the tooltip in characters.

Return value

Type: HRESULT

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

Remarks

If this method returns S_OK, the client provides its own tooltip. Otherwise the INameSpaceTreeControl will extract one.

Requirements

Requirement Value
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2008 [desktop apps only]
Target Platform Windows
Header shobjidl.h

See also

INameSpaceTreeControlEvents

IShellItem