VCCodeModel.AddMacro, méthode

Article
05/16/2015

Ajoute un élément #define à un fichier spécifique.

Espace de noms : Microsoft.VisualStudio.VCCodeModel
Assembly : Microsoft.VisualStudio.VCCodeModel (dans Microsoft.VisualStudio.VCCodeModel.dll)

Syntaxe

'Déclaration
Function AddMacro ( _
    Name As String, _
    Location As Object, _
    Value As String, _
    Position As Object _
) As VCCodeMacro

VCCodeMacro AddMacro(
    string Name,
    Object Location,
    string Value,
    Object Position
)

VCCodeMacro^ AddMacro(
    String^ Name, 
    Object^ Location, 
    String^ Value, 
    Object^ Position
)

abstract AddMacro : 
        Name:string * 
        Location:Object * 
        Value:string * 
        Position:Object -> VCCodeMacro

function AddMacro(
    Name : String, 
    Location : Object, 
    Value : String, 
    Position : Object
) : VCCodeMacro

Paramètres

Name
Type : String

Requis. Spécifie le nom de la macro.

Location
Type : Object

Requis. Chemin d'accès ou nom du fichier à modifier. Si le fichier n'existe pas déjà, il est créé automatiquement. 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 AddMacro échoue.

Value
Type : String

Optionnel. Texte de la définition de macro.

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 CodeElement, le nouvel élément est ajouté directement après.

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.

Valeur de retour

Type : Microsoft.VisualStudio.VCCodeModel.VCCodeMacro
Objet VCCodeMacro.

Notes

Appelez cette fonction pour ajouter un élément #define, directive (C/C++) au fichier spécifié.

Consultez Comment : compiler l'exemple de code pour l'extensibilité du modèle de code Visual C++ pour plus d'informations sur la compilation et l'exécution de cet exemple.

Exemples

Cet exemple ajoute une macro instruction au fichier de stdafx.h.

Sub AddMacro()
    Dim codeModel As VCCodeModel
    codeModel = DTE.Solution.Item(1).CodeModel
    Dim macro As VCCodeMacro
    macro = codeModel.AddMacro("LAST_CHAR", "File.h", "'Z'")
End Sub

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.

Voir aussi

Référence

VCCodeModel Interface

Microsoft.VisualStudio.VCCodeModel, espace de noms

Partager via