IVsXMLMemberData3.GetParamTextAt(Int32, String, String) Method

Definition

Namespace:

Microsoft.VisualStudio.Shell.Interop

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

Gets the text describing a specific parameter.

public:
 int GetParamTextAt(int iParam, [Runtime::InteropServices::Out] System::String ^ % pbstrName, [Runtime::InteropServices::Out] System::String ^ % pbstrText);

int GetParamTextAt(int iParam, [Runtime::InteropServices::Out] std::wstring const & & pbstrName, [Runtime::InteropServices::Out] std::wstring const & & pbstrText);

public int GetParamTextAt (int iParam, out string pbstrName, out string pbstrText);

abstract member GetParamTextAt : int * string * string -> int

Public Function GetParamTextAt (iParam As Integer, ByRef pbstrName As String, ByRef pbstrText As String) As Integer

Parameters

iParam

Int32

[in] The position of the parameter in the signature.

pbstrName

String

[out] The name of the parameter.

pbstrText

String

[out] The text describing the parameter.

Returns

Int32

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

COM Signature

From vsshell80.idl:

HRESULT IVsXMLMemberData3::GetParamTextAt(  
   [in] long iParam,   
   [out] BSTR *pbstrName,   
   [out] BSTR *pbstrText  
);