CompletionSet::GetDescriptionText Method (Int32, String^)

Visual Studio 2015

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

Namespace: Microsoft.VisualStudio.Package
Assembly: Microsoft.VisualStudio.Package.LanguageService.14.0 (in Microsoft.VisualStudio.Package.LanguageService.14.0.dll)

Syntax

C++

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

Parameters

index: Type: System::Int32
[in] The index of the item for which to get a description.

description: Type: System::String^
[out] Returns the description, or null if there is no description.

Return Value

Type: System::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.