MethodData.GetParameterText(Int32, Int32, ParameterTextType) Method
Definition
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 parameter text for the specified method signature.
public:
virtual IntPtr GetParameterText(int method, int parameter, Microsoft::VisualStudio::TextManager::Interop::ParameterTextType type);
public IntPtr GetParameterText (int method, int parameter, Microsoft.VisualStudio.TextManager.Interop.ParameterTextType type);
abstract member GetParameterText : int * int * Microsoft.VisualStudio.TextManager.Interop.ParameterTextType -> nativeint
override this.GetParameterText : int * int * Microsoft.VisualStudio.TextManager.Interop.ParameterTextType -> nativeint
Public Function GetParameterText (method As Integer, parameter As Integer, type As ParameterTextType) As IntPtr
Parameters
- parameter
- Int32
[in] An index to the specified parameter.
- type
- ParameterTextType
[in] A value from the ParameterTextType enumeration specifying what type of text to return.
Returns
nativeint
If successful, returns a marshaled pointer to the requested string; otherwise, returns a null value.
Implements
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.