Partager via


IVsCompletionSetBuilder.GetBuilderDisplayText(Int32, String, Int32[]) Method

Definition

Gets the builder’s display text.

int GetBuilderDisplayText(int iIndex, [Runtime::InteropServices::Out] std::wstring const & & pbstrText, std::Array <int> const & piGlyph);
public int GetBuilderDisplayText (int iIndex, out string pbstrText, int[] piGlyph);
abstract member GetBuilderDisplayText : int * string * int[] -> int
Public Function GetBuilderDisplayText (iIndex As Integer, ByRef pbstrText As String, Optional piGlyph As Integer()) As Integer

Parameters

iIndex
Int32

[in] The index of the completion set.

pbstrText
String

[in] The display text.

piGlyph
Int32[]

[out, optional] A glyph for the display text.

Returns

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.

Applies to