VCFileCodeModel.AddMacro-Methode

Artikel
05/16/2015

Fügt dem VCFileCodeModel-Objekt ein #define-Element hinzu.

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

Syntax

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

Parameter

Name
Typ: String

Erforderlich. Gibt den Namen (in Anführungszeichen oder spitzen Klammern) der Datei an, die eingeschlossen wird.

Value
Typ: String

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

Position
Typ: Object

Erforderlich. 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 ein Element in #define-Direktive (C/C++) die Datei einzufügen, die vom VCFileCodeModel-Objekt dargestellt wird.

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 Datei hinzu, die vom vcFile-Objekt dargestellt wird.

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

VCFileCodeModel Schnittstelle

Microsoft.VisualStudio.VCCodeModel-Namespace

Freigeben über