IVsMethodData.GetMethodText Method

Article
11/19/2013

Gets a method return type, method name, or method description.

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

Syntax

'Declaration
Function GetMethodText ( _
    iMethod As Integer, _
    type As MethodTextType _
) As IntPtr

IntPtr GetMethodText(
    int iMethod,
    MethodTextType type
)

IntPtr GetMethodText(
    [InAttribute] int iMethod, 
    [InAttribute] MethodTextType type
)

abstract GetMethodText : 
        iMethod:int * 
        type:MethodTextType -> IntPtr

function GetMethodText(
    iMethod : int, 
    type : MethodTextType
) : IntPtr

Parameters

iMethod
Type: System.Int32

[in] Method number.

type
Type: Microsoft.VisualStudio.TextManager.Interop.MethodTextType

[in] Method text type values to return. For a list of type values see MethodTextType.

Return Value

Type: System.IntPtr
Returns the text of the specified method type. May be nulla null reference (Nothing in Visual Basic).

Remarks

COM Signature

From textmgr.idl:

const WCHAR * IVsMethodData::GetMethodText(
   [in] long iMethod, 
   [in] MethodTextType type
);

This method is called repeatedly by the view to display the various portions of the method text as determined by the values specified in the type parameter. These values include information for method type, name, description, bracket, and delimiter. If brackets (parentheses, and so on) and delimiters are not required for your language, return an empty string to force the view to display nothing.

.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