CodeFunction.Parameters Property

Definition

Namespace:

EnvDTE

Assembly:

Microsoft.VisualStudio.Interop.dll

Gets a collection of parameters for this item.

public:
 property EnvDTE::CodeElements ^ Parameters { EnvDTE::CodeElements ^ get(); };

[System.Runtime.InteropServices.DispId(36)]
public EnvDTE.CodeElements Parameters { [System.Runtime.InteropServices.DispId(36)] [System.Runtime.InteropServices.TypeLibFunc(1024)] get; }

[<System.Runtime.InteropServices.DispId(36)>]
[<get: System.Runtime.InteropServices.DispId(36)>]
[<get: System.Runtime.InteropServices.TypeLibFunc(1024)>]
member this.Parameters : EnvDTE.CodeElements

Public ReadOnly Property Parameters As CodeElements

Property Value

CodeElements

A CodeElements collection.

Attributes

DispIdAttribute TypeLibFuncAttribute

Examples

 Sub ParametersExample(ByVal dte As DTE2)  

    ' Before running this example, open a code document from a project  
    ' and place the insertion point inside a function.  
    Try  
        ' Retrieve the CodeFunction at the insertion point.  
        Dim sel As TextSelection = _  
            CType(dte.ActiveDocument.Selection, TextSelection)  
        Dim fun As CodeFunction = _  
            CType(sel.ActivePoint.CodeElement( _  
            vsCMElement.vsCMElementFunction), CodeFunction)  

        ' Display the function's parameters.  
        Dim params As String  
        Dim param As CodeParameter  
        For Each param In fun.Parameters  
            Dim start As TextPoint = param.GetStartPoint()  
            Dim finish As TextPoint = param.GetEndPoint()  
            params &= start.CreateEditPoint.GetText(finish) & vbCrLf  
        Next  

        MsgBox(fun.Name & " has the following parameters:" & _  
            vbCrLf & vbCrLf & params)  
    Catch ex As Exception  
        MsgBox(ex.Message)  
    End Try  

End Sub  

 public void ParametersExample(DTE2 dte)  
{  
    // Before running this example, open a code document from a project  
    // and place the insertion point inside a function.  
    try  
    {  
        // Retrieve the CodeFunction at the insertion point.  
        TextSelection sel =   
            (TextSelection)dte.ActiveDocument.Selection;  
        CodeFunction fun =   
            (CodeFunction)sel.ActivePoint.get_CodeElement(  
            vsCMElement.vsCMElementFunction);  

        // Display the function's parameters.  
        string parms = "";  
        foreach (CodeParameter param in fun.Parameters)  
        {  
            TextPoint start =   
                param.GetStartPoint(vsCMPart.vsCMPartWhole);  
            TextPoint finish =   
                param.GetEndPoint(vsCMPart.vsCMPartWhole);  
            parms += start.CreateEditPoint().GetText(finish) +   
                Environment.NewLine;  
        }  

        MessageBox.Show(fun.Name + " has the following parameters:" +   
            Environment.NewLine + Environment.NewLine + parms);  
    }  
    catch (Exception ex)  
    {  
        MessageBox.Show(ex.Message);  
    }  
}  

Remarks

Note

The values of code model elements such as classes, structs, functions, attributes, delegates, and so forth can be non-deterministic after making certain kinds of edits, meaning that their values cannot be relied upon to always remain the same. For more information, see the section Code Model Element Values Can Change in Discovering Code by Using the Code Model (Visual Basic).