CodeFunction2.AddParameter-Methode

Artikel
05/16/2015

Erstellt ein neues Parameter-Codekonstrukt und fügt den Code am korrekten Ort ein.

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

Parameter

Name
Typ: String

Erforderlich. Der Name des Parameters.

Type
Typ: Object

Erforderlich. Eine vsCMTypeRef-Konstante, die den Rückgabedatentyp der Funktion angibt. Dies kann ein CodeTypeRef-Objekt, eine vsCMTypeRef-Konstante oder ein vollqualifizierter Typname sein.

Position
Typ: Object

Dies ist optional. Standardwert = 0. Das Codeelement, nach dem das neue Element eingefügt werden soll. Wenn der Wert ein CodeElement ist, wird das neue Element direkt im Anschluss eingefügt.

Wenn der Wert ein Long-Datentyp ist, dann gibt AddParameter das Element an, nach dem das neue Element eingefügt werden soll.

Da Auflistungen mit dem Index 1 beginnen, gibt ein Übergabewert von 0 an, dass das neue Element zu Anfang der Auflistung eingefügt werden soll. Der Wert -1 bedeutet, dass das Element am Ende eingefügt werden soll.

Rückgabewert

Typ: CodeParameter
Ein CodeParameter-Objekt.

Hinweise

Visual C++ verlangt ein Format mit Trennung durch Doppelpunkte (::) oder die vollqualifizierten Typnamen. Alle anderen Sprachen unterstützen das Format mit Trennung durch Punkte.

Die Gültigkeit der Argumente wird durch die Sprache des Codemodells bestimmt.

Hinweis

Die Werte von Codemodellelementen wie z. B. Klassen, Strukturen, Funktionen, Attributen Delegaten usw. sind nach bestimmten Änderungen unter Umständen nicht deterministisch, d. h. deren Werte bleiben nicht zuverlässig immer gleich.Weitere Informationen finden Sie im Abschnitt "Codemodellelemente können sich ändern" in Ermitteln von Code über das Codemodell (Visual Basic).

Beispiele

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

Volle Vertrauenswürdigkeit für den unmittelbaren Aufrufer. Dieser Member kann von nur teilweise vertrauenswürdigem Code nicht verwendet werden. Weitere Informationen finden Sie unter Verwenden von Bibliotheken aus teilweise vertrauenswürdigem Code.