Share via


CodeFunction.AddParameter Method

Creates a new parameter code construct and inserts the code in the correct location.

Namespace:  EnvDTE
Assembly:  EnvDTE (in EnvDTE.dll)

Syntax

'Declaration
Function AddParameter ( _
    Name As String, _
    Type As Object, _
    Position As Object _
) As CodeParameter
CodeParameter AddParameter(
    string Name,
    Object Type,
    Object Position
)
CodeParameter^ AddParameter(
    String^ Name, 
    Object^ Type, 
    Object^ Position
)
abstract AddParameter : 
        Name:string * 
        Type:Object * 
        Position:Object -> CodeParameter 
function AddParameter(
    Name : String, 
    Type : Object, 
    Position : Object
) : CodeParameter

Parameters

  • Position
    Type: System.Object
    Optional. Default = 0. The code element after which to add the new element. If the value is a CodeElement, then the new element is added immediately after it.
    If the value is a Long data type, then AddParameter indicates the element after which to add the new element.
    Because collections begin their count at 1, passing 0 indicates that the new element should be placed at the beginning of the collection. A value of -1 means that the element should be placed at the end.

Return Value

Type: EnvDTE.CodeParameter
A CodeParameter object.

Remarks

Native Native Visual C++ requires the colon-separated (::) format for its fully qualified type names. All other languages support the period-separated format.

The correctness of the arguments is determined by the language behind the code model.

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

Examples

 Sub AddParameterExample(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)

        ' Add a parameter to the function.
        fun.AddParameter("TestParam", vsCMTypeRef.vsCMTypeRefInt)
    Catch ex As Exception
        MsgBox(ex.Message)
    End Try

End Sub
 public void AddParameterExample(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);

        // Add a parameter to the function.
        fun.AddParameter("TestParam", vsCMTypeRef.vsCMTypeRefInt, -1);
    }
    catch (Exception ex)
    {
        MessageBox.Show(ex.Message);
    }
}

.NET Framework Security

See Also

Reference

CodeFunction Interface

EnvDTE Namespace

Other Resources

How to: Compile and Run the Automation Object Model Code Examples

Discovering Code by Using the Code Model (Visual Basic)

Discovering Code by Using the Code Model (Visual C#)