IVsSccManagerTooltip::GetGlyphTipText Method (IVsHierarchy^, UInt32, String^)

Visual Studio 2015

Provides ToolTip text based on the source control data for a specific node in the project's hierarchy Solution Explorer.

Namespace: Microsoft.VisualStudio.Shell.Interop
Assembly: Microsoft.VisualStudio.Shell.Interop.8.0 (in Microsoft.VisualStudio.Shell.Interop.8.0.dll)

Syntax

C++

int GetGlyphTipText(
	IVsHierarchy^ phierHierarchy,
	unsigned int itemidNode,
	[OutAttribute] String^% pbstrTooltipText
)

Parameters

phierHierarchy: Type: Microsoft.VisualStudio.Shell.Interop::IVsHierarchy^
[in] Owner hierarchy of node (null if it is a solution).

itemidNode: Type: System::UInt32
[in] The ID of the node for which the ToolTip is requested.

pbstrTooltipText: Type: System::String^
[out] ToolTip text.

Return Value

Type: System::Int32

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

COM Signature

From ivssccmanagertooltip.idl

C++

HRESULT GetGlyphTipText(
   [in] IVsHierarchy *phierHierarchy,
   [in] VSITEMID itemidNode,
   [out, retval] BSTR *pbstrTooltipText
);

This method provides the text for the ToolTip of a source control glyph. The glyph is drawn to the left of the file icon in Solution Explorer, and it indicates the source control status of a file.