CodeDelegate2.AddParameter Method

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

Namespace:  EnvDTE80
Assembly:  EnvDTE80 (in EnvDTE80.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

• Name
  Type: System.String
  Required. The name of the parameter.

• Type
  Type: System.Object
  Required. A vsCMTypeRef constant indicating the data type that the function returns. This can be a CodeTypeRef object, a vsCMTypeRef constant, or a fully qualified type name.

• Position
  Type: System.Object
  Optional. Default = 0. The code element after which to add the parameter. If Value is a CodeElement, then the new element is added immediately after it.
  If 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 the element should be placed at the end.

Return Value

Type: EnvDTE.CodeParameter
A CodeParameter object.

Implements

CodeDelegate.AddParameter(String, Object, Object)

Remarks

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

Before running this example, load a project with a class and insert the following line along with the example code. After both the line and the example code are added, click the Delegate line to place the insertion point there, and then run the example.

[VisualBasic]

Delegate Sub MySubDelegate(ByVal x As Integer)

[C#]

public delegate void MySubDelegate(int x);

[VisualBasic]

Public Sub addDelegateParamExample(ByVal dte As DTE2)
    Try
        ' Retrieve the CodeClass at the insertion point.
        Dim sel As TextSelection = _
          CType(dte.ActiveDocument.Selection, TextSelection)
        Dim del As CodeDelegate2 = _
          CType(sel.ActivePoint.CodeElement( _
        vsCMElement.vsCMElementDelegate), CodeDelegate2)

       ' Add a new parameter to the delegate.
       del.AddParameter("someNewBase", "Solution2", -1)
    Catch ex As System.Exception
        MsgBox(ex.ToString)
    End Try
End Sub

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

See Also

Reference

CodeDelegate2 Interface

EnvDTE80 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#)