IVsExpansionFunction.GetListText Method

Article
2013-03-11

Returns the specified value from a list of values associated with the expansion function.

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

Syntax

'Declaration
Function GetListText ( _
    iIndex As Integer, _
    <OutAttribute> ByRef pbstrText As String _
) As Integer

int GetListText(
    int iIndex,
    out string pbstrText
)

int GetListText(
    [InAttribute] int iIndex, 
    [OutAttribute] String^% pbstrText
)

abstract GetListText : 
        iIndex:int * 
        pbstrText:string byref -> int

function GetListText(
    iIndex : int, 
    pbstrText : String
) : int

Parameters

iIndex
Type: System.Int32
[in] The index of the value to retrieve.

pbstrText
Type: System.String%
[out] Returns a string that contains the requested value.

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 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.

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

Share via