ExpansionFunction.GetListText(Int32, String) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Package

Assembly:: Microsoft.VisualStudio.Package.LanguageService.14.0.dll

Assembly:: Microsoft.VisualStudio.Package.LanguageService.15.0.dll

Package:: Microsoft.VisualStudio.Package.LanguageService.15.0 v17.12.40392

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.

Gets the value of the specified list item.

public:
 virtual int GetListText(int iIndex, [Runtime::InteropServices::Out] System::String ^ % ppszText);

 virtual int GetListText(int iIndex, [Runtime::InteropServices::Out] std::wstring const & & ppszText);

public virtual int GetListText (int iIndex, out string ppszText);

abstract member GetListText : int * string -> int
override this.GetListText : int * string -> int

Public Overridable Function GetListText (iIndex As Integer, ByRef ppszText As String) As Integer

Parameters

iIndex: Int32

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

ppszText: String

[out] Returns the value of the requested list item.

Returns

Int32

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

Implements

GetListText(Int32, String)

Remarks

This method is an implementation of the GetListText method on the IVsExpansionFunction interface.

The base method returns the requested value from the list as returned from the GetIntellisenseList method. If the list does not exist, the base method returns null for the string. The base method always returns a success code of S_OK. Note: if the index is out of range, an exception is thrown.

Applies to

Share via