VCCodeModel.AddInclude-Methode

  • Artikel

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

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

Syntax

'Declaration
Function AddInclude ( _
    Name As String, _
    Location As Object, _
    Position As Object _
) As VCCodeInclude

VCCodeInclude AddInclude(
    string Name,
    Object Location,
    Object Position
)

VCCodeInclude^ AddInclude(
    String^ Name, 
    Object^ Location, 
    Object^ Position
)

abstract AddInclude : 
        Name:string * 
        Location:Object * 
        Position:Object -> VCCodeInclude 

function AddInclude(
    Name : String, 
    Location : Object, 
    Position : Object
) : VCCodeInclude

Parameter

  • Name
    Typ: System.String
    Erforderlich.Gibt den Namen (in Anführungszeichen oder spitzen Klammern) der Datei an, die eingeschlossen wird.
  • Location
    Typ: System.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 AddInclude fehl.
  • Position
    Typ: System.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.VCCodeInclude
Ein VCCodeInclude-Objekt.

Hinweise

Rufen Sie diese Funktion auf, um ein #include-Direktive (C/C++)-Element in die angegebene Datei des VCCodeModel-Objekt eingefügt werden soll.

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 eine #include stdafx.h-Datei der Anweisung hinzu.

Sub AddInclude()
    Dim codeModel As VCCodeModel
    codeModel = DTE.Solution.Item(1).CodeModel
    Dim include As VCCodeInclude
    include = codeModel.AddInclude("""stdafx.h""", "File.h", 0)
End Sub

.NET Framework-Sicherheit

Siehe auch

Referenz

VCCodeModel Schnittstelle

Microsoft.VisualStudio.VCCodeModel-Namespace