IVsXMLMemberData.GetParamTextAt(Int32, String, String) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

Assembly:: Microsoft.VisualStudio.Shell.Interop.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

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.

Gets description of a specified 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] Parameter location in signature

pbstrName: String

[out] Parameter name

pbstrText: String

[out] Description of parameter

Returns

Int32

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

Remarks

COM Signature

From vsshell.idl:

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

Applies to