IVsSccManagerTooltip.GetGlyphTipText(IVsHierarchy, UInt32, String) Method

Definition

Namespace:

Microsoft.VisualStudio.Shell.Interop

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

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

public:
 int GetGlyphTipText(Microsoft::VisualStudio::Shell::Interop::IVsHierarchy ^ phierHierarchy, System::UInt32 itemidNode, [Runtime::InteropServices::Out] System::String ^ % pbstrTooltipText);

int GetGlyphTipText(Microsoft::VisualStudio::Shell::Interop::IVsHierarchy const & phierHierarchy, unsigned int itemidNode, [Runtime::InteropServices::Out] std::wstring const & & pbstrTooltipText);

public int GetGlyphTipText (Microsoft.VisualStudio.Shell.Interop.IVsHierarchy phierHierarchy, uint itemidNode, out string pbstrTooltipText);

abstract member GetGlyphTipText : Microsoft.VisualStudio.Shell.Interop.IVsHierarchy * uint32 * string -> int

Public Function GetGlyphTipText (phierHierarchy As IVsHierarchy, itemidNode As UInteger, ByRef pbstrTooltipText As String) As Integer

Parameters

phierHierarchy

IVsHierarchy

[in] Owner hierarchy of node (null if it is a solution).

itemidNode

UInt32

[in] The ID of the node for which the ToolTip is requested.

pbstrTooltipText

String

[out] ToolTip text.

Returns

Int32

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

Remarks

COM Signature

From ivssccmanagertooltip.idl

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.