VCCodeModel-Schnittstelle

  • Artikel

Ein Objekt, das Zugriff auf ein beliebiges enthaltenes Codeelement auf Projektebene bietet.

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

Syntax

'Declaration
<GuidAttribute("5A716328-5325-4A51-AEF4-EFBB8A10B89F")> _
Public Interface VCCodeModel _
    Inherits CodeModel2

[GuidAttribute("5A716328-5325-4A51-AEF4-EFBB8A10B89F")]
public interface VCCodeModel : CodeModel2

[GuidAttribute(L"5A716328-5325-4A51-AEF4-EFBB8A10B89F")]
public interface class VCCodeModel : CodeModel2

[<GuidAttribute("5A716328-5325-4A51-AEF4-EFBB8A10B89F")>]
type VCCodeModel =  
    interface
        interface CodeModel2
    end

public interface VCCodeModel extends CodeModel2

Der VCCodeModel-Typ macht die folgenden Member verfügbar.

Eigenschaften

  Name Beschreibung
Öffentliche Eigenschaft Attributes Ruft eine Auflistung aller Attribute für das Objekt ab.
Öffentliche Eigenschaft Classes Ruft eine Auflistung von Klassen für das Objekt ab.
Öffentliche Eigenschaft CodeElements Ruft eine Auflistung von Codeelementen ab.
Öffentliche Eigenschaft Delegates Ruft eine Auflistung von Delegaten für das Objekt ab.
Öffentliche Eigenschaft DialogClasses Ruft eine Auflistung von Dialogfeldklassen ab.
Öffentliche Eigenschaft DTE Ruft das Erweiterbarkeitsobjekt der obersten Ebene ab.
Öffentliche Eigenschaft Enums Ruft eine Auflistung von Enumerationen für das Objekt ab.
Öffentliche Eigenschaft Functions Ruft eine Auflistung von Funktionen für das Objekt ab.
Öffentliche Eigenschaft IDLImports Ruft die Auflistung der Import-Anweisungen aus der IDL-Datei des übergeordneten Objekts ab.
Öffentliche Eigenschaft IDLLibraries Ruft die Auflistung von Library-Elementen für das Objekt ab.
Öffentliche Eigenschaft Imports Ruft die Auflistung von #import-Anweisungen für das übergeordnete Objekt ab.
Öffentliche Eigenschaft Includes Ruft die Auflistung von #include-Anweisungen für das Objekt ab.
Öffentliche Eigenschaft Interfaces Ruft die Auflistung von Schnittstellen für das Objekt ab.
Öffentliche Eigenschaft IsCaseSensitive Ruft einen Wert ab, der angibt, ob bei einem Codeelement die Groß-/Kleinschreibung beachtet wird.
Öffentliche Eigenschaft IsSynchronized Bestimmt, ob das VCCodeModel mit dem Quellcode für die Projektmappe synchronisiert ist.
Öffentliche Eigenschaft Language Ruft die zum Schreiben von Code verwendete Programmiersprache ab.
Öffentliche Eigenschaft Macros Ruft die Auflistung von Makros (#define-Anweisungen) für das Objekt ab.
Öffentliche Eigenschaft Maps Ruft die Auflistung von Zuordnungen für das Objekt ab.
Öffentliche Eigenschaft Namespaces Ruft die Auflistung von Namespaces für das Objekt ab.
Öffentliche Eigenschaft Parent Ruft das unmittelbar übergeordnete Objekt eines angegebenen Objekts ab.
Öffentliche Eigenschaft Structs Ruft die Auflistung von Strukturelementen für das Objekt ab.
Öffentliche Eigenschaft Typedefs Ruft die Auflistung von Typedef-Elementen für das Objekt ab.
Öffentliche Eigenschaft Unions Ruft die Auflistung von Union-Elementen für das Objekt ab.
Öffentliche Eigenschaft Usings Ruft die Auflistung von #using-Elementen für das Objekt ab.
Öffentliche Eigenschaft Variables Ruft die Auflistung von Variablen für das Objekt ab.

Zum Seitenanfang

Methoden

  Name Beschreibung
Öffentliche Methode AbortTransaction Bricht die aktuelle Transaktion ab.
Öffentliche Methode AddAttribute Erstellt ein neues Attributcodekonstrukt und fügt den Code an der korrekten Position ein.
Öffentliche Methode AddClass Erstellt ein neues Klassencodekonstrukt und fügt den Code an der korrekten Position ein.
Öffentliche Methode AddDelegate Erstellt ein neues Delegatcodekonstrukt und fügt den Code an der korrekten Position ein.
Öffentliche Methode AddEnum Erstellt ein neues Enumerationscodekonstrukt und fügt den Code an der korrekten Position ein.
Öffentliche Methode AddFunction Erstellt ein neues Funktionscodekonstrukt und fügt den Code an der korrekten Position ein.
Öffentliche Methode AddIDLImport Fügt einer bestimmten IDL-Datei eine neue import-Anweisung hinzu.
Öffentliche Methode AddIDLLibrary Fügt einer bestimmten IDL-Datei eine neue library-Anweisung hinzu.
Öffentliche Methode AddImport Fügt einer bestimmten Datei ein #import-Element hinzu.
Öffentliche Methode AddInclude Fügt einer bestimmten Datei ein #include-Element hinzu.
Öffentliche Methode AddInterface Erstellt ein neues Schnittstellencodekonstrukt und fügt den Code an der korrekten Position ein.
Öffentliche Methode AddMacro Fügt einer bestimmten Datei ein #define-Element hinzu.
Öffentliche Methode AddMap Fügt dem Objekt einen Zuordnungseintrag hinzu.
Öffentliche Methode AddNamespace Erstellt ein neues Namespacecodekonstrukt und fügt den Code an der korrekten Position ein.
Öffentliche Methode AddStruct Erstellt ein neues Strukturcodekonstrukt und fügt den Code an der korrekten Position ein.
Öffentliche Methode AddTypedef Fügt einer bestimmten Datei ein typedef-Element hinzu.
Öffentliche Methode AddUnion Fügt dem VCCodeModel-Objekt ein union-Element hinzu.
Öffentliche Methode AddUsing Fügt einer bestimmten Datei ein #using-Element hinzu.
Öffentliche Methode AddVariable Erstellt ein neues Variablencodekonstrukt und fügt den Code an der korrekten Position ein.
Öffentliche Methode CodeElementFromFullName Ruft eine Auflistung der angegebenen Codeelemente für das Objekt ab.
Öffentliche Methode CodeElementFromFullName2 Ruft eine Auflistung der angegebenen Codeelemente für das Objekt ab.Die Funktion ist mit CodeElementFromFullName identisch, mit der Ausnahme, dass sie während der Suche Namespaces ignoriert.
Öffentliche Methode CodeTypeFromFullName Gibt ein Codeelement zurück, das auf einem voll gekennzeichneten Namen basiert.
Öffentliche Methode CodeTypeFromFullName2 Gibt ein Codeelement zurück, das auf einem voll gekennzeichneten Namen basiert.Die Funktion ist mit CodeTypeFromFullName identisch, mit der Ausnahme, dass sie eine typedef-Auflösung auszuführen versucht.
Öffentliche Methode CommitTransaction Führt für das Objekt einen Commit für die aktuelle Transaktion aus.
Öffentliche Methode CreateCodeTypeRef Ein CodeTypeRef-Objekt, das auf dem übergebenen Datentypindikator basiert.
Öffentliche Methode DotNetNameFromLanguageSpecific Übersetzt den Namespace in das .NET-Format.
Öffentliche Methode ElementFromID Nicht implementiert.
Öffentliche Methode GetClassesDerivedFrom
Öffentliche Methode IsValidID Gibt zurück, ob ein angegebener Name ein gültiger Programmbezeichner für die aktuelle Sprache ist.
Öffentliche Methode LanguageSpecificNameFromDotNet Übersetzt den vollqualifizierten Namen in das Format eines nicht verwalteten Namespaces.
Öffentliche Methode Remove Entfernt das angegebene Projekt aus der Projektmappe.
Öffentliche Methode RemoveEx Entfernt das angegebene Projekt aus der Projektmappe.
Öffentliche Methode StartTransaction Beginnt eine Transaktion.
Öffentliche Methode Synchronize Synchronisiert alle Codemodellobjekte in der Projektmappe mit an Quelldateien vorgenommenen Bearbeitungen.
Öffentliche Methode SynchronizeCancellable Zeigt ein Dialogfeld mit einer Statusanzeige an.Der Benutzer kann den Wartevorgang abbrechen und die Blockierung des Threads aufheben.
Öffentliche Methode SynchronizeFiles Stellt sicher, dass die FileCodeModel-Eigenschaft für eine Projektdatei nicht NULL ist.
Öffentliche Methode ValidateMember Überprüft, ob der vorgeschlagene Name ein gültiger C++-Name für die im Kontext des übergeordneten Objekts angegebene Art ist.
Öffentliche Methode ValidateMemberName

Zum Seitenanfang

Hinweise

Das Codemodell Objekt stellt VCCodeModel-Funktionen in verschiedenen Sprachen bereit, die von Visual Studio unterstützt werden (einschließlich Visual C++) auf Projektebene.

Hauptsächlich wird dieses Objekt verwendet, um ein beliebiges Codeelement zu suchen, das sich innerhalb eines Projekts zugegriffen werden kann (wenn ein vollqualifizierter Name).Darüber hinaus gibt das Objekt die Programmiersprache, in der das Projekt geschrieben werden soll.

HinweisHinweis

Ein großer Teil der Funktionen dieses Objekts wird vom Visual Studio- CodeModel2-Objekt bereitgestellt.

Wenn Sie ein VCCodeModel-Objekt innerhalb eines verwalteten Projekts verwenden, schließen Sie Microsoft.VisualStudio.VCCodeModel.dll als Verweis ein.Weitere Informationen zum Hinzufügen von Verweisen auf ein verwaltetes Projekt finden Sie unter Gewusst wie: Hinzufügen oder Entfernen von Verweisen mithilfe des Dialogfelds "Verweise hinzufügen".

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

Diese Funktion gibt das VCCodeModel-Objekt zurück, das das erste Projekt in einer Projektmappe darstellt.

Function GetVCCodeModel() As VCCodeModel
    GetVCCodeModel = Nothing
    Dim codeModel As CodeModel
    Dim vcCodeModel As VCCodeModel
    Dim solution As Solution
    solution = DTE.Solution
    If (solution Is Nothing) Then
        MsgBox("A Solution is not open")
        Exit Function
    Else
        If (DTE.Solution.Count <> 0) Then
            codeModel = DTE.Solution.Item(1).CodeModel
            vcCodeModel = CType(codeModel, VCCodeModel)
            If (vcCodeModel Is Nothing) Then
                MsgBox("The first project is not a VC++ project.")
                Exit Function
            Else
                GetVCCodeModel = vcCodeModel
            End If
        End If
    End If
End Function

Siehe auch

Referenz

Microsoft.VisualStudio.VCCodeModel-Namespace