Método CodeFunction2.AddParameter

Artigo
05/17/2015

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

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

Sintaxe

'Declaração
Function AddParameter ( _
    Name As String, _
    Type As Object, _
    Position As Object _
) As CodeParameter

CodeParameter AddParameter(
    string Name,
    Object Type,
    Object Position
)

CodeParameter^ AddParameter(
    String^ Name, 
    Object^ Type, 
    Object^ Position
)

abstract AddParameter : 
        Name:string * 
        Type:Object * 
        Position:Object -> CodeParameter

function AddParameter(
    Name : String, 
    Type : Object, 
    Position : Object
) : CodeParameter

Parâmetros

Name
Tipo: String

Obrigatório. O nome do parâmetro.

Type
Tipo: Object

Obrigatório. Um vsCMTypeRef constante que indica o tipo de dados que a função retorna. Isso pode ser um CodeTypeRef 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, em seguida, o novo elemento é adicionado imediatamente após ele.

Se o valor for uma longa, em seguida, AddParameter indica o elemento depois do qual 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. Um valor de-1 significa que o elemento deve ser colocado no final.

Valor de retorno

Tipo: CodeParameter
Um objeto CodeParameter.

Comentários

Visual C++ requer o formato separado por dois-pontos (:) para seus nomes de tipo totalmente qualificado. Todos os outros idiomas suportam ao formato separados.

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

Dica

Os valores dos elementos de modelo de código como classes, estruturas, funções, atributos, delegados e assim por diante podem ser não determinístico depois de fazer determinados tipos de edições, o que significa que seus valores não podem ser considerados para sempre permanecem os mesmos.Para obter mais informações, consulte a seção valores de elemento de modelo de código podem ser alterados em Descobrindo código usando o modelo de código (Visual Basic).

Exemplos

Sub AddParameterExample(ByVal dte As DTE2)

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

        ' Add a parameter to the function.
        fun.AddParameter("TestParam", vsCMTypeRef.vsCMTypeRefInt)
    Catch ex As Exception
        MsgBox(ex.Message)
    End Try

End Sub

public void AddParameterExample(DTE2 dte)
{
    // Before running this example, open a code document from a project
    // and place the insertion point inside a function.
    try
    {
        // Retrieve the CodeFunction at the insertion point.
        TextSelection sel = 
            (TextSelection)dte.ActiveDocument.Selection;
        CodeFunction fun = 
            (CodeFunction)sel.ActivePoint.get_CodeElement(
            vsCMElement.vsCMElementFunction);

        // Add a parameter to the function.
        fun.AddParameter("TestParam", vsCMTypeRef.vsCMTypeRefInt, -1);
    }
    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.