Share via


CompletionSet.GetDescriptionText(Int32, String) Method

Definition

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

public:
 virtual int GetDescriptionText(int index, [Runtime::InteropServices::Out] System::String ^ % description);
int GetDescriptionText(int index, [Runtime::InteropServices::Out] std::wstring const & & description);
public int GetDescriptionText (int index, out string description);
abstract member GetDescriptionText : int * string -> int
override this.GetDescriptionText : int * string -> int
Public Function GetDescriptionText (index As Integer, ByRef description As String) As Integer

Parameters

index
Int32

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

description
String

[out] Returns the description, or null if there is no description.

Returns

If successful, returns S_OK; otherwise, returns an error.

Implements

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.

Applies to