IVsCompletionSet.GetDisplayText 方法

,当出现在设置的完成列表,返回设置完成项的文本。

命名空间:  Microsoft.VisualStudio.TextManager.Interop
程序集:  Microsoft.VisualStudio.TextManager.Interop(在 Microsoft.VisualStudio.TextManager.Interop.dll 中)

语法

声明
Function GetDisplayText ( _
    iIndex As Integer, _
    <OutAttribute> ByRef ppszText As String, _
    <OutAttribute> piGlyph As Integer() _
) As Integer
int GetDisplayText(
    int iIndex,
    out string ppszText,
    int[] piGlyph
)
int GetDisplayText(
    [InAttribute] int iIndex, 
    [OutAttribute] String^% ppszText, 
    [OutAttribute] array<int>^ piGlyph
)
abstract GetDisplayText : 
        iIndex:int * 
        ppszText:string byref * 
        piGlyph:int[] byref -> int
function GetDisplayText(
    iIndex : int, 
    ppszText : String, 
    piGlyph : int[]
) : int

参数

  • iIndex
    类型:Int32

    [in] 完成索引设置项目返回显示文本。

  • ppszText
    类型:String%

    [out] 返回包含显示的文本字符串。

  • piGlyph
    类型:array<Int32[]

    [out] 返回标识标志符号的整数对完成项旁显示。

返回值

类型:Int32
如果方法成功,则返回 S_OK。如果失败,它会返回一个错误代码。

备注

COM 签名

从 textmgr.idl:

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

应由完成安装的对象维护返回的字符串,因此,该字符串应保持有效直到最后的版本,或者,在更新通过调用 UpdateCompletionStatus。 视图用于GetImageList 确定图像列表与设置的完成。

备注

字符串通常由完成设置的对象创建的,而字符串必须保持在该对象生存期或直到 Dismiss 方法调用。

如果实现托管代码的此接口,并且需要封送该字符串处理由调用方,请实现 IVsCoTaskMemFreeMyStrings 接口。

.NET Framework 安全性

请参阅

参考

IVsCompletionSet 接口

Microsoft.VisualStudio.TextManager.Interop 命名空间