CompletionSet.GetDescriptionText Method

Article
04/29/2015

Gets a description for the specified item in the completion list.

Namespace: Microsoft.VisualStudio.Package
Assemblies:   Microsoft.VisualStudio.Package.LanguageService.11.0 (in Microsoft.VisualStudio.Package.LanguageService.11.0.dll)
  Microsoft.VisualStudio.Package.LanguageService.12.0 (in Microsoft.VisualStudio.Package.LanguageService.12.0.dll)
  Microsoft.VisualStudio.Package.LanguageService.9.0 (in Microsoft.VisualStudio.Package.LanguageService.9.0.dll)
  Microsoft.VisualStudio.Package.LanguageService.10.0 (in Microsoft.VisualStudio.Package.LanguageService.10.0.dll)
  Microsoft.VisualStudio.Package.LanguageService (in Microsoft.VisualStudio.Package.LanguageService.dll)

Syntax

'Declaration
Public Function GetDescriptionText ( _
    index As Integer, _
    <OutAttribute> ByRef description As String _
) As Integer

public int GetDescriptionText(
    int index,
    out string description
)

public:
virtual int GetDescriptionText(
    int index, 
    [OutAttribute] String^% description
) sealed

abstract GetDescriptionText : 
        index:int * 
        description:string byref -> int  
override GetDescriptionText : 
        index:int * 
        description:string byref -> int

public final function GetDescriptionText(
    index : int, 
    description : String
) : int

Parameters

index
Type: Int32

[in] The index of the item for which to get a description.

description
Type: String%

[out] Returns the description, or nulla null reference (Nothing in Visual Basic) if there is no description.

Return Value

Type: Int32
If successful, returns S_OK; otherwise, returns an error.

Implements

IVsCompletionSet.GetDescriptionText(Int32, String%)

Remarks

The description text is typically displayed in a tool tip next to the item currently selected in the completion list.

This method is an implementation of the GetDescriptionText method on the IVsCompletionSet interface.

The base method forwards the call to the GetDescription method on the Declarations object that was passed to the Init method. The base method always returns a success code of S_OK.

.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.

Partager via