VCFileCodeModel.AddMacro, méthode

Article
05/16/2015

Ajoute un élément #define à l'objet VCFileCodeModel.

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

Syntaxe

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

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

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

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

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

Paramètres

Name
Type : String

Obligatoire. Indique le nom (entre guillemets ou crochets pointus) du fichier à inclure.

Value
Type : String

Optionnel. Texte de la définition de macro.

Position
Type : Object

Obligatoire. 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 insérer un élément de #define, directive (C/C++) dans le fichier représenté par l'objet d'VCFileCodeModel.

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 représenté par l'objet d'vcFile.

Sub AddMacro()
    Dim vcFile as VCFileCodeModel
    vcFile = DTE.Solution.Item(1).ProjectItems.Item(1).FileCodeModel
    vcFile.AddMacro("LAST_CHAR", "'Z'", 0)
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

VCFileCodeModel Interface

Microsoft.VisualStudio.VCCodeModel, espace de noms

Partager via