VCCodeModel.AddMacro-Methode

Artikel
05/16/2015

Fügt einer bestimmten Datei ein #define-Element hinzu.

Namespace: Microsoft.VisualStudio.VCCodeModel
Assembly: Microsoft.VisualStudio.VCCodeModel (in Microsoft.VisualStudio.VCCodeModel.dll)

Syntax

'Declaration
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

Parameter

Name
Typ: String

Erforderlich. Gibt den Namen des Makros an.

Location
Typ: Object

Erforderlich. Der Pfad oder Dateiname der zu ändernden Datei. Wenn die Datei nicht vorhanden ist, wird sie automatisch erstellt. Die Datei wird dem Projekt hinzugefügt, wenn sie nicht bereits als Projektelement vorhanden ist. Wenn die Datei nicht erstellt und dem Projekt hinzugefügt werden kann, schlägt AddMacro fehl.

Value
Typ: String

Optional. Der Text für die Definition des Makros.

Position
Typ: Object

Optional. Standardwert = 0. Das Codeelement, hinter dem das neue Element hinzugefügt werden soll. Wenn der Wert ein CodeElement ist, wird das neue Element unmittelbar im Anschluss hinzugefügt.

Da die Zählung bei Auflistungen mit 1 beginnt, wird mit dem Wert 0 angegeben, dass das neue Element am Anfang der Auflistung eingefügt werden soll. Bei dem Wert -1 wird das Element am Ende eingefügt.

Rückgabewert

Typ: Microsoft.VisualStudio.VCCodeModel.VCCodeMacro
Ein VCCodeMacro-Objekt.

Hinweise

Rufen Sie diese Funktion auf, um einen #define-Direktive (C/C++)-Element der angegebenen Datei hinzuzufügen.

Weitere Informationen zum Kompilieren und Ausführen dieses Beispiels finden Sie unter Gewusst wie: Kompilieren von Beispielcode für die Erweiterbarkeit des Visual C++-Codemodells.

Beispiele

In diesem Beispiel wird einer Makroanweisung der stdafx.h-Datei hinzu.

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

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

Siehe auch

Referenz

VCCodeModel Schnittstelle

Microsoft.VisualStudio.VCCodeModel-Namespace

Freigeben über