Método CodeClass.AddFunction

Artigo
05/17/2015

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

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

Sintaxe

'Declaração
Function AddFunction ( _
    Name As String, _
    Kind As vsCMFunction, _
    Type As Object, _
    Position As Object, _
    Access As vsCMAccess, _
    Location As Object _
) As CodeFunction

CodeFunction AddFunction(
    string Name,
    vsCMFunction Kind,
    Object Type,
    Object Position,
    vsCMAccess Access,
    Object Location
)

CodeFunction^ AddFunction(
    String^ Name, 
    vsCMFunction Kind, 
    Object^ Type, 
    Object^ Position, 
    vsCMAccess Access, 
    Object^ Location
)

abstract AddFunction : 
        Name:string * 
        Kind:vsCMFunction * 
        Type:Object * 
        Position:Object * 
        Access:vsCMAccess * 
        Location:Object -> CodeFunction

function AddFunction(
    Name : String, 
    Kind : vsCMFunction, 
    Type : Object, 
    Position : Object, 
    Access : vsCMAccess, 
    Location : Object
) : CodeFunction

Parâmetros

Name
Tipo: String

Obrigatório. O nome da nova função.

Kind
Tipo: EnvDTE.vsCMFunction

Obrigatório. O vsCMFunction constante indicando o tipo de função, como, por exemplo, se a função é um property-get, um método e assim por diante.

Type
Tipo: Object

Obrigatório. A vsCMTypeRef constante indicando o tipo de dados que a função retorna. Isso pode ser um CodeTypeRef o objeto, um vsCMTypeRef constante ou um nome de tipo totalmente qualificado.

Position
Tipo: 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 for um longo, em seguida, AddFunction 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.

Access
Tipo: EnvDTE.vsCMAccess

Opcional. A vsCMAccess constante.

Location
Tipo: Object

Opcional. O local.

Valor de retorno

Tipo: EnvDTE.CodeFunction
A CodeFunction object.

Comentários

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.

Dica

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 código usando o modelo de código (Visual Basic).

Exemplos

 Sub AddFunctionExample2(ByVal dte As DTE2)

    ' Before running this example, open a code document from a project
    ' and place the insertion point inside a class definition.
    Try
        ' Retrieve the CodeClass at the insertion point.
        Dim sel As TextSelection = _
            CType(dte.ActiveDocument.Selection, TextSelection)
        Dim cls As CodeClass = _
            CType(sel.ActivePoint.CodeElement( _
            vsCMElement.vsCMElementClass), CodeClass)

        ' Create a new member function.
        cls.AddFunction("TestFunction", _
            vsCMFunction.vsCMFunctionFunction, _
            vsCMTypeRef.vsCMTypeRefInt)
    Catch ex As Exception
        MsgBox(ex.Message)
    End Try

End Sub

public void AddFunctionExample2(DTE2 dte)
{
    // Before running this example, open a code document from a project
    // and place the insertion point inside a class definition.
    try
    {
        // Retrieve the CodeClass at the insertion point.
        TextSelection sel = 
            (TextSelection)dte.ActiveDocument.Selection;
        CodeClass cls = 
            (CodeClass)sel.ActivePoint.get_CodeElement(
            vsCMElement.vsCMElementClass);

        // Create a new member function.
        cls.AddFunction("TestFunction", 
            vsCMFunction.vsCMFunctionFunction, 
            vsCMTypeRef.vsCMTypeRefInt, -1, 
            vsCMAccess.vsCMAccessDefault, null);
    }
    catch (Exception ex)
    {
        MessageBox.Show(ex.Message);
    }
}

Segurança do .NET Framework

Confiança total para o chamador imediato. O membro não pode ser usado por código parcialmente confiável. Para obter mais informações, consulte Usando bibliotecas de código parcialmente confiável.