IVsCompletionSet.GetDescriptionText(Int32, String) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.TextManager.Interop

Assembly:: Microsoft.VisualStudio.TextManager.Interop.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.9.37000

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Returns text describing the indicated item in the completion set.

public:
 int GetDescriptionText(int iIndex, [Runtime::InteropServices::Out] System::String ^ % pbstrDescription);

int GetDescriptionText(int iIndex, [Runtime::InteropServices::Out] std::wstring const & & pbstrDescription);

public int GetDescriptionText (int iIndex, out string pbstrDescription);

abstract member GetDescriptionText : int * string -> int

Public Function GetDescriptionText (iIndex As Integer, ByRef pbstrDescription As String) As Integer

Parameters

iIndex: Int32

[in] Index identifying the item in the completion set to provide description text for.

pbstrDescription: String

[out] Returns a string containing the description text.

Returns

Int32

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

Remarks

COM Signature

From textmgr.idl:

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.

Applies to