MethodData::GetParameterText Method (Int32, Int32, ParameterTextType)

Visual Studio 2015

Returns the specified parameter text for the specified method signature.

Namespace: Microsoft.VisualStudio.Package
Assembly: Microsoft.VisualStudio.Package.LanguageService.14.0 (in Microsoft.VisualStudio.Package.LanguageService.14.0.dll)

Syntax

C++

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

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.