IVsXMLMemberData.GetParamTextAt Method

Article
03/06/2013

Gets description of a specified parameter.

Namespace: Microsoft.VisualStudio.Shell.Interop
Assembly: Microsoft.VisualStudio.Shell.Interop (in Microsoft.VisualStudio.Shell.Interop.dll)

Syntax

'Declaration
Function GetParamTextAt ( _
    iParam As Integer, _
    <OutAttribute> ByRef pbstrName As String, _
    <OutAttribute> ByRef pbstrText As String _
) As Integer

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

int GetParamTextAt(
    [InAttribute] int iParam, 
    [OutAttribute] String^% pbstrName, 
    [OutAttribute] String^% pbstrText
)

abstract GetParamTextAt : 
        iParam:int * 
        pbstrName:string byref * 
        pbstrText:string byref -> int

function GetParamTextAt(
    iParam : int, 
    pbstrName : String, 
    pbstrText : String
) : int

Parameters

iParam
Type: System.Int32
[in] Parameter location in signature

pbstrName
Type: System.String%
[out] Parameter name

pbstrText
Type: System.String%
[out] Description of parameter

Return Value

Type: System.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
);

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