Partager via


ExpansionFunction.GetListText Method

Gets the value of the specified list item.

Namespace:  Microsoft.VisualStudio.Package
Assemblies:   Microsoft.VisualStudio.Package.LanguageService.9.0 (in Microsoft.VisualStudio.Package.LanguageService.9.0.dll)
  Microsoft.VisualStudio.Package.LanguageService.12.0 (in Microsoft.VisualStudio.Package.LanguageService.12.0.dll)
  Microsoft.VisualStudio.Package.LanguageService.10.0 (in Microsoft.VisualStudio.Package.LanguageService.10.0.dll)
  Microsoft.VisualStudio.Package.LanguageService.11.0 (in Microsoft.VisualStudio.Package.LanguageService.11.0.dll)
  Microsoft.VisualStudio.Package.LanguageService (in Microsoft.VisualStudio.Package.LanguageService.dll)

Syntax

'Declaration
Public Overridable Function GetListText ( _
    iIndex As Integer, _
    <OutAttribute> ByRef ppszText As String _
) As Integer
public virtual int GetListText(
    int iIndex,
    out string ppszText
)
public:
virtual int GetListText(
    int iIndex, 
    [OutAttribute] String^% ppszText
)
abstract GetListText : 
        iIndex:int * 
        ppszText:string byref -> int  
override GetListText : 
        iIndex:int * 
        ppszText:string byref -> int
public function GetListText(
    iIndex : int, 
    ppszText : String
) : int

Parameters

  • iIndex
    Type: Int32

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

  • ppszText
    Type: String%

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

Return Value

Type: Int32
If successful, returns S_OK; otherwise, returns an error code.

Implements

IVsExpansionFunction.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 nulla null reference (Nothing in Visual Basic) 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.

.NET Framework Security

See Also

Reference

ExpansionFunction Class

Microsoft.VisualStudio.Package Namespace