IVsCompletionSet.GetDisplayText(Int32, String, Int32[]) Метод

Определение

Возвращает текст элемента набора завершений так, как он отображается в списке наборов завершения.

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

Параметры

iIndex
Int32

[in] Индекс элемента набора завершений, для которого необходимо вернуть отображаемый текст.

ppszText
String

[out] Возвращает строку, содержащую отображаемый текст.

piGlyph
Int32[]

[out] Возвращает целое число, указывающее глиф для отображения рядом с элементом завершения.

Возвращаемое значение

Int32

Если метод завершается успешно, возвращает значение S_OK. В противном случае функция возвращает код ошибки.

Комментарии

Подпись COM

Из текстмгр. IDL:

HRESULT IVsCompletionSet::GetDisplayText(  
   [in] long iIndex,  
   [out] WCHAR **ppszText,  
   [out, optional] long *piGlyph  
);  

Возвращаемая строка должна поддерживаться объектом Set завершения, а строка должна оставаться действительной до окончательного выпуска или пока не будет обновлена путем вызова UpdateCompletionStatus . GetImageList используется представлением для определения списка образов, связанных с набором завершения.

Примечание

Строка обычно создается объектом набора завершения, а строка должна сохраняться в течение времени существования этого объекта или до Dismiss вызова метода.

Если вы реализуете этот интерфейс в управляемом коде и вам нужна строка, удаленная вызывающим объектом, реализуйте IVsCoTaskMemFreeMyStrings интерфейс.

Применяется к