IVsExpansionFunction.GetListText(Int32, String) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.TextManager.Interop

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

Assembly:: Microsoft.VisualStudio.Interop.dll

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 the specified value from a list of values associated with the expansion function.

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

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

public int GetListText (int iIndex, out string pbstrText);

abstract member GetListText : int * string -> int

Public Function GetListText (iIndex As Integer, ByRef pbstrText As String) As Integer

Parameters

iIndex: Int32

[in] The index of the value to retrieve.

pbstrText: String

[out] Returns a string that contains the requested value.

Returns

Int32

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

Remarks

COM Signature

From textmgr2.idl:

void IVsExpansionFunction::GetListText(  
   [in]long iIndex,  
   [out]const WCHAR** pbstrText  
);

The returned string must continue for the life of the expansion function object itself or until the ReleaseFunction method is called.

Applies to