Método CodeModel2.AddStruct (String, Object, Object, Object, Object, vsCMAccess)

  • Artigo

Cria uma nova construção de código de estrutura e insere o código no local correto.

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

Sintaxe

'Declaração
Function AddStruct ( _
    Name As String, _
    Location As Object, _
    Position As Object, _
    Bases As Object, _
    ImplementedInterfaces As Object, _
    Access As vsCMAccess _
) As CodeStruct

CodeStruct AddStruct(
    string Name,
    Object Location,
    Object Position,
    Object Bases,
    Object ImplementedInterfaces,
    vsCMAccess Access
)

CodeStruct^ AddStruct(
    String^ Name, 
    Object^ Location, 
    Object^ Position, 
    Object^ Bases, 
    Object^ ImplementedInterfaces, 
    vsCMAccess Access
)

abstract AddStruct : 
        Name:string * 
        Location:Object * 
        Position:Object * 
        Bases:Object * 
        ImplementedInterfaces:Object * 
        Access:vsCMAccess -> CodeStruct 

function AddStruct(
    Name : String, 
    Location : Object, 
    Position : Object, 
    Bases : Object, 
    ImplementedInterfaces : Object, 
    Access : vsCMAccess
) : CodeStruct

Parâmetros

  • Name
    Tipo: System.String
    Obrigatório.O nome da nova estrutura.
  • Location
    Tipo: System.Object
    Obrigatório.O nome de arquivo e caminho para a nova definição de estrutura.Dependendo do idioma, o nome do arquivo é relativo ou absoluto para o arquivo de projeto.O arquivo é adicionado ao projeto, se já não é um item de projeto.Se o arquivo não pode ser criado e adicionado ao projeto, em seguida, AddStruct falhar.
  • Position
    Tipo: System.Object
    Opcional.Padrão = 0.O elemento de código após o qual você deseja adicionar o novo elemento.Se o valor for um CodeElement, e em seguida, o novo elemento é adicionado imediatamente após ele.
    Se o valor é um tipo de dados longos, em seguida, AddStruct indica o elemento após o qual você deseja adicionar o novo elemento.
    Porque coleções começam sua contagem em 1, passando de 0 indica que o novo elemento deve ser colocado no início da coleção.O valor-1 significa que o elemento deve ser colocado no final.
  • Bases
    Tipo: System.Object
    Obrigatório.Valor padrão é Nothing.Uma variante que mantém um SafeArray de nomes de tipo totalmente qualificado ou CodeInterface objetos do qual deriva a nova interface.
  • ImplementedInterfaces
    Tipo: System.Object
    Obrigatório.Valor padrão é Nothing.Um SafeArray de nomes de tipo totalmente qualificado ou CodeInterfaces que representa o que a nova classe promete implementar interfaces.

Valor de retorno

Tipo: EnvDTE.CodeStruct
A CodeStruct object.

Comentários

Nativo Visual C++ requer separados por dois-pontos (::) format para seus nomes de tipo totalmente qualificado.Todos os outros idiomas oferecem suporte o formato separado por período.

A correção dos argumentos é determinada pelo idioma atrás o modelo de código.

ObservaçãoObservação

Os valores de elementos de modelo de código, como classes, estruturas, funções, atributos, delegados e assim por diante podem ser não-determinísticos depois de fazer determinados tipos de edições, o que significa que seus valores não confie sempre permanecer o mesmo.Para obter mais informações, consulte a seção valores de elemento de modelo de código podem ser alterada de Descobrindo o código usando o modelo de código (Visual Basic).

Exemplos

Sub AddStructExample(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 classes array and the implemented 
        ' interfaces array.
        Dim bases() As Object = {ConvertFullName(cm, "System.Object")}
        Dim interfaces() As Object = { _
            ConvertFullName(cm, "System.IDisposable"), _
            ConvertFullName(cm, "System.IComparable") _
        }

        ' Create a new struct.
        cm.AddStruct("TestStruct", projItem.Name, , bases, interfaces)
    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 AddStructExample(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 classes array and the implemented 
        // interfaces array.
        object[] bases = {ConvertFullName(cm, "System.Object")};
        object[] interfaces = {
        ConvertFullName(cm, "System.IDisposable"),
        ConvertFullName(cm, "System.IComparable")
        };

        // Create a new struct.
        cm.AddStruct("TestStruct", projItem.Name, -1, bases, 
            interfaces, 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;
}

Segurança do .NET Framework

Consulte também

Referência

CodeModel2 Interface

Sobrecargas AddStruct

Namespace EnvDTE80

Outros recursos

Como: compilar e executar os exemplos de código de modelo de objeto de automação

Descobrindo o código usando o modelo de código (Visual Basic)

Descobrindo o código usando o modelo de código (Visual C#)