MethodData.GetParameterText Method

Artikel
02/04/2013

Returns the specified parameter text for the specified method signature.

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

Syntax

'Declaration
Public Function GetParameterText ( _
    method As Integer, _
    parameter As Integer, _
    type As ParameterTextType _
) As IntPtr

public IntPtr GetParameterText(
    int method,
    int parameter,
    ParameterTextType type
)

public:
virtual IntPtr GetParameterText(
    int method, 
    int parameter, 
    ParameterTextType type
) sealed

abstract GetParameterText : 
        method:int * 
        parameter:int * 
        type:ParameterTextType -> IntPtr 
override GetParameterText : 
        method:int * 
        parameter:int * 
        type:ParameterTextType -> IntPtr

public final function GetParameterText(
    method : int, 
    parameter : int, 
    type : ParameterTextType
) : IntPtr

Parameters

method
Type: System.Int32
[in] An index in the Methods object to the specified method signature.

parameter
Type: System.Int32
[in] An index to the specified parameter.

type
Type: Microsoft.VisualStudio.TextManager.Interop.ParameterTextType
[in] A value from the ParameterTextType enumeration specifying what type of text to return.

Return Value

Type: System.IntPtr
If successful, returns a marshaled pointer to the requested string; otherwise, returns a null value.

Implements

IVsMethodData.GetParameterText(Int32, Int32, ParameterTextType)

Remarks

This method is used to access the text associated with a parameter. This includes the parameter name, description, and declaration.

This method is an implementation of the GetParameterText method on the IVsMethodData interface.

The base method call the GetParameterInfo method on the Methods object (that was passed to the Refresh method) for the specified method signature and parameter and then returns the appropriate string for each type of parameter text.

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

Bagikan melalui