CodeClass2.AddVariable, méthode

Article
05/16/2015

Crée une variable dans la classe.

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

Syntaxe

'Déclaration
Function AddVariable ( _
    Name As String, _
    Type As Object, _
    Position As Object, _
    Access As vsCMAccess, _
    Location As Object _
) As CodeVariable

CodeVariable AddVariable(
    string Name,
    Object Type,
    Object Position,
    vsCMAccess Access,
    Object Location
)

CodeVariable^ AddVariable(
    String^ Name, 
    Object^ Type, 
    Object^ Position, 
    vsCMAccess Access, 
    Object^ Location
)

abstract AddVariable : 
        Name:string * 
        Type:Object * 
        Position:Object * 
        Access:vsCMAccess * 
        Location:Object -> CodeVariable

function AddVariable(
    Name : String, 
    Type : Object, 
    Position : Object, 
    Access : vsCMAccess, 
    Location : Object
) : CodeVariable

Paramètres

Name
Type : String

Obligatoire. Nom de la nouvelle variable.

Type
Type : Object

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

Optionnel. Valeur par défaut = 0. Élément de code après lequel le nouvel élément doit être ajouté.

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

Comme la comptabilisation des collections commence à 1, passer 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.

Access
Type : vsCMAccess

Optionnel. Constante vsCMAccess.

Location
Type : Object

Optionnel. Chemin d'accès et nom de fichier de la nouvelle définition de variable. Selon le langage, le nom de fichier est relatif ou absolu par rapport au fichier projet. Le fichier est ajouté au projet s'il n'est pas déjà un élément de projet. Si vous ne pouvez pas créer et ajouter le fichier au projet, la méthode AddVariable échoue.

Valeur de retour

Type : CodeVariable
Objet CodeVariable.

Notes

Le code Visual C++ natif 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, au-delà du 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éterminables 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

[C#]

public void CodeClass2AddVariableExample(DTE2 dte2)
    {
    // Before running this example, open a code document from a project
    // and place the insertion point inside a class definition.
    try
    {
        // Retrieve the CodeClass at the insertion point.
        TextSelection sel =
            (TextSelection)dte2.ActiveDocument.Selection;
        CodeClass2 cls =
            (CodeClass2)sel.ActivePoint.get_CodeElement(
            vsCMElement.vsCMElementClass);
        object pos = -1; // Place variable at end of members collection
        // Add variable to ActiveDocument.
        CodeVariable cvar = cls.AddVariable("TestAddVar",
            vsCMTypeRef.vsCMTypeRefFloat, pos,
            vsCMAccess.vsCMAccessProtected, null);
    }
    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.