Share via

IVsCompletionSetBuilder.GetBuilderDisplayText Method

  • Article

Gets the builder’s display text.

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

Syntax

'Declaration
Function GetBuilderDisplayText ( _
    iIndex As Integer, _
    <OutAttribute> ByRef pbstrText As String, _
    <OutAttribute> piGlyph As Integer() _
) As Integer

int GetBuilderDisplayText(
    int iIndex,
    out string pbstrText,
    int[] piGlyph
)

int GetBuilderDisplayText(
    [InAttribute] int iIndex, 
    [OutAttribute] String^% pbstrText, 
    [OutAttribute] array<int>^ piGlyph
)

abstract GetBuilderDisplayText : 
        iIndex:int * 
        pbstrText:string byref * 
        piGlyph:int[] byref -> int

function GetBuilderDisplayText(
    iIndex : int, 
    pbstrText : String, 
    piGlyph : int[]
) : int

Parameters

  • iIndex
    Type: System.Int32

    [in] The index of the completion set.

  • piGlyph
    Type: array<System.Int32[]

    [out, optional] A glyph for the display 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 textmgr2.idl:

HRESULT IVsCompletionSetBuilder::GetBuilderDisplayText(
   [in] long iIndex,
   [out] const WCHAR **ppszText,
   [out, optional] long *piGlyph
);

Note

The text buffer is created by the IVsCompletionSetBuilder object and the buffer must persist for the life of the IVsCompletionSetBuilder object or until the OnBuilderCommit method is called.

.NET Framework Security

See Also

Reference

IVsCompletionSetBuilder Interface

Microsoft.VisualStudio.TextManager.Interop Namespace