IVsSccManagerTooltip.GetGlyphTipText Method

Article
2013-03-06

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

'Declaration
Function GetGlyphTipText ( _
    phierHierarchy As IVsHierarchy, _
    itemidNode As UInteger, _
    <OutAttribute> ByRef pbstrTooltipText As String _
) As Integer

int GetGlyphTipText(
    IVsHierarchy phierHierarchy,
    uint itemidNode,
    out string pbstrTooltipText
)

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

abstract GetGlyphTipText : 
        phierHierarchy:IVsHierarchy * 
        itemidNode:uint32 * 
        pbstrTooltipText:string byref -> int

function GetGlyphTipText(
    phierHierarchy : IVsHierarchy, 
    itemidNode : uint, 
    pbstrTooltipText : String
) : int

Parameters

phierHierarchy
Type: Microsoft.VisualStudio.Shell.Interop.IVsHierarchy
[in] Owner hierarchy of node (nulla null reference (Nothing in Visual Basic) 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

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.

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

Share via