IVsCompletionSet::GetDescriptionText Method (Int32, String^)

Visual Studio 2015

Returns text describing the indicated item in the completion set.

Namespace: Microsoft.VisualStudio.TextManager.Interop
Assembly: Microsoft.VisualStudio.TextManager.Interop (in Microsoft.VisualStudio.TextManager.Interop.dll)

Syntax

C++

int GetDescriptionText(
	int iIndex,
	[OutAttribute] String^% pbstrDescription
)

Parameters

iIndex: Type: System::Int32
[in] Index identifying the item in the completion set to provide description text for.

pbstrDescription: Type: System::String^
[out] Returns a string containing the description text.

Return Value

Type: System::Int32

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

COM Signature

From textmgr.idl:

C++

HRESULT IVsCompletionSet::GetDescriptionText(
   [in] long iIndex,
   [out] BSTR *pbstrDescription
);

The view calls the GetDescriptionText method when it needs to update the description text shown for the completion set items currently in view. The view calls this method once for each completion-set item it needs to update.