CodeModel2.AddInterface-Methode (String, Object, Object, Object, vsCMAccess)

Erstellt ein neues Schnittstellencodekonstrukt und fügt den Code an der korrekten Position ein.

Namespace:  EnvDTE80
Assembly:  EnvDTE80 (in EnvDTE80.dll)

Syntax

'Declaration
Function AddInterface ( _
    Name As String, _
    Location As Object, _
    Position As Object, _
    Bases As Object, _
    Access As vsCMAccess _
) As CodeInterface
CodeInterface AddInterface(
    string Name,
    Object Location,
    Object Position,
    Object Bases,
    vsCMAccess Access
)
CodeInterface^ AddInterface(
    String^ Name, 
    Object^ Location, 
    Object^ Position, 
    Object^ Bases, 
    vsCMAccess Access
)
abstract AddInterface : 
        Name:string * 
        Location:Object * 
        Position:Object * 
        Bases:Object * 
        Access:vsCMAccess -> CodeInterface 
function AddInterface(
    Name : String, 
    Location : Object, 
    Position : Object, 
    Bases : Object, 
    Access : vsCMAccess
) : CodeInterface

Parameter

  • Name
    Typ: System.String
    Erforderlich.Der Name der hinzuzufügenden Schnittstelle.
  • Location
    Typ: System.Object
    Erforderlich.Der Pfad- und Dateiname für die neue Schnittstellendefinition.Je nach Sprache wird der Dateiname entweder relativ oder absolut zur Projektdatei angegeben.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 AddInterface fehl.
  • Position
    Typ: System.Object
    Optional.Standard = 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.
    Wenn der Wert ein Long-Datentyp ist, gibt AddInterface das Element an, nach dem das neue Element hinzugefügt werden soll.
    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.
  • Bases
    Typ: System.Object
    Optional.Standardwert ist Nothing oder nullNULL-Verweis (Nothing in Visual Basic).Eine Variante, die ein SafeArray mit vollqualifizierten Typnamen oder CodeInterface-Objekte enthält, von dem bzw. denen die neue Schnittstelle abgeleitet wird.

Rückgabewert

Typ: EnvDTE.CodeInterface
Ein CodeInterface-Objekt.

Implementiert

CodeModel.AddInterface(String, Object, Object, Object, vsCMAccess)

Hinweise

Im systemeigenen Visual C++ ist ein doppelter Doppelpunkt (::) als Trennzeichen für vollqualifizierte Typnamen erforderlich. Alle anderen Sprachen unterstützen das durch Punkte getrennte Format.

Die Gültigkeit der Argumente wird durch die Sprache des Codemodells bestimmt.

Tipp

Die Werte von Codemodellelementen wie Klassen, Strukturen, Funktionen, Attributen, Delegaten usw. können nach bestimmten Bearbeitungsvorgängen nicht deterministisch sein, d. h., dass nicht mehr davon ausgegangen werden kann, dass ihre Werte immer unverändert bleiben. Weitere Informationen finden Sie im Abschnitt zum Änderungsverhalten von Codemodellelementwerten unter Ermitteln von Code über das Codemodell (Visual Basic).

Beispiele

Sub AddInterfaceExample(ByVal dte As DTE2)

    ' Before running this example, open a code document from a project.
    Try
        Dim projItem As ProjectItem = dte.ActiveDocument.ProjectItem
        Dim cm As CodeModel = projItem.ContainingProject.CodeModel

        ' Initialize the base interfaces array.
        Dim bases() As Object = { _
            ConvertFullName(cm, "System.IDisposable"), _
            ConvertFullName(cm, "System.IComparable") _
        }

        ' Create a new class.
        cm.AddInterface("TestInterface", projItem.Name, , bases)
    Catch ex As Exception
        MsgBox(ex.Message)
    End Try

End Sub

Function ConvertFullName(ByVal cm As CodeModel, _
    ByVal fullName As String) As String

    ' Convert a .NET type name into a C++ type name.
    If (cm.Language = CodeModelLanguageConstants.vsCMLanguageVC) Or _
        (cm.Language = CodeModelLanguageConstants.vsCMLanguageMC) Then
        Return fullName.Replace(".", "::")
    Else
        Return fullName
    End If

End Function
public void AddInterfaceExample(DTE2 dte)
{
    // Before running this example, open a code document from
    // a project.
    try
    {
        ProjectItem projItem = dte.ActiveDocument.ProjectItem;
        CodeModel cm = projItem.ContainingProject.CodeModel;

        // Initialize the base interfaces array.
        object[] bases = {
        ConvertFullName(cm, "System.IDisposable"), 
        ConvertFullName(cm, "System.IComparable")
        };

        // Create a new class.
        cm.AddInterface("TestInterface", projItem.Name, -1, bases, 
            vsCMAccess.vsCMAccessPublic);
    }
    catch (Exception ex)
    {
        MessageBox.Show(ex.Message);
    }
}

string ConvertFullName(CodeModel cm, string fullName)
{
    // Convert a .NET type name into a C++ type name.
    if ((cm.Language == CodeModelLanguageConstants.vsCMLanguageVC) || 
        (cm.Language == CodeModelLanguageConstants.vsCMLanguageMC))
        return fullName.Replace(".", "::");
    else
        return fullName;
}

.NET Framework-Sicherheit

Siehe auch

Referenz

CodeModel2 Schnittstelle

AddInterface-Überladung

EnvDTE80-Namespace

Weitere Ressourcen

Gewusst wie: Kompilieren und Ausführen der Codebeispiele für das Automatisierungsobjektmodell

Ermitteln von Code über das Codemodell (Visual Basic)

Ermitteln von Code über das Codemodell (Visual C#)