CodeFunction2.AddParameter, méthode

Article
05/16/2015

Crée une construction de code de paramètre et insère le code à l'emplacement approprié.

Espace de noms : EnvDTE80
Assembly : EnvDTE80 (dans EnvDTE80.dll)

Syntaxe

'Déclaration
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

Paramètres

Name
Type : String

Requis. Nom du paramètre.

Type
Type : Object

Requis. Constante vsCMTypeRef indiquant le type de données retourné par la fonction. Il peut s'agir d'un objet CodeTypeRef, d'une constante vsCMTypeRef ou d'un nom de type qualifié complet.

Position
Type : Object

Facultatif. Valeur par défaut = 0. Élément de code après lequel le nouvel élément doit être ajouté. Si la valeur est CodeElement, le nouvel élément est ajouté directement après.

Si la valeur est de type Long, AddParameter indique l'élément après lequel le nouvel élément doit être ajouté.

Comme la comptabilisation des collections commence à 1, la transmission de la valeur 0 indique que le nouvel élément doit être placé au début de la collection. La valeur -1 signifie que l'élément doit être placé à la fin.

Valeur de retour

Type : CodeParameter
Objet CodeParameter.

Notes

Visual C++ nécessite le format séparé par deux-points (::) pour ses noms de types qualifiés complets. Tous les autres langages prennent en charge le format séparé par des points.

L'exactitude des arguments est déterminée par le langage derrière le modèle de code.

Notes

Les valeurs d'éléments de modèle de code, tels que des classes, des structures, des fonctions, des attributs, des délégués, etc., peuvent être non déterministes après certains types de modifications, ce qui signifie qu'il n'est pas certain que leurs valeurs resteront inchangées.Pour plus d'informations, consultez la section Les valeurs d'élément de modèle de code peuvent être modifiées de la rubrique Découverte de code à l'aide du modèle de code (Visual Basic).

Exemples

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);
    }
}

Sécurité .NET Framework

Confiance totale accordée à l'appelant immédiat. Ce membre ne peut pas être utilisé par du code d'un niveau de confiance partiel. Pour plus d'informations, voir Utilisation de bibliothèques à partir de code d'un niveau de confiance partiel.