Método CodeClass2.AddVariable

Artigo
05/17/2015

Cria uma nova variável na classe.

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

Sintaxe

'Declaração
Function AddVariable ( _
    Name As String, _
    Type As Object, _
    Position As Object, _
    Access As vsCMAccess, _
    Location As Object _
) As CodeVariable

CodeVariable AddVariable(
    string Name,
    Object Type,
    Object Position,
    vsCMAccess Access,
    Object Location
)

CodeVariable^ AddVariable(
    String^ Name, 
    Object^ Type, 
    Object^ Position, 
    vsCMAccess Access, 
    Object^ Location
)

abstract AddVariable : 
        Name:string * 
        Type:Object * 
        Position:Object * 
        Access:vsCMAccess * 
        Location:Object -> CodeVariable

function AddVariable(
    Name : String, 
    Type : Object, 
    Position : Object, 
    Access : vsCMAccess, 
    Location : Object
) : CodeVariable

Parâmetros

Name
Tipo: String

Necessário. O nome da nova variável.

Type
Tipo: Object

Necessário. Uma constante de vsCMTypeRef que indica o tipo de dados que a função retorna. Esse pode ser um objeto de CodeTypeRef , uma constante de vsCMTypeRef , ou um nome de tipo totalmente qualificado.

Position
Tipo: Object

Opcional. Padrão = 0. O elemento de código depois do qual adicionar o novo elemento.

Se o valor for um tipo de dados longo, então Position indica o elemento depois do qual adicionar o novo elemento.

Como as coleções começam a contagem em 1, passar 0 indica que o novo elemento deve ser colocado no topo da coleção. Um valor de -1 significa que o elemento deve ser colocado no final.

Access
Tipo: vsCMAccess

Opcional. Uma constante de vsCMAccess .

Location
Tipo: Object

Opcional. O caminho e o nome do arquivo para a nova definição de variável. Dependendo do idioma, o nome do arquivo é relativo ou absoluto para o arquivo de projeto. O arquivo é adicionado ao projeto se não é mais um item de projeto. Se o arquivo não pode ser criado e adicionado ao projeto e, em seguida AddVariable falha.

Valor de retorno

Tipo: CodeVariable
Um objeto CodeVariable.

Comentários

O Visual C++ nativo requer o formato separado por dois pontos de :: () para seus nomes totalmente qualificados do tipo. Todos os outros idiomas dão suporte ao formato período- separado.

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

Dica

Os valores de código de modelagem elementos como classes, estruturas, funções, atributos, representantes, e assim por diante podem ser não determinísticas depois de fazer determinados tipos as edições do, o que significa que seus valores não podem ser confiáveis em para permanecer sempre os mesmos.Para obter mais informações, veja que os valores do elemento do modelo de código da seção podem ser alteradas em Descobrindo código usando o modelo de código (Visual Basic).

Exemplos

[C#]

public void CodeClass2AddVariableExample(DTE2 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.
        TextSelection sel =
            (TextSelection)dte2.ActiveDocument.Selection;
        CodeClass2 cls =
            (CodeClass2)sel.ActivePoint.get_CodeElement(
            vsCMElement.vsCMElementClass);
        object pos = -1; // Place variable at end of members collection
        // Add variable to ActiveDocument.
        CodeVariable cvar = cls.AddVariable("TestAddVar",
            vsCMTypeRef.vsCMTypeRefFloat, pos,
            vsCMAccess.vsCMAccessProtected, 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.