Método VCCodeModel.AddMacro

Artigo
05/17/2015

Adiciona um elemento de #define a um arquivo específico.

Namespace: Microsoft.VisualStudio.VCCodeModel
Assembly: Microsoft.VisualStudio.VCCodeModel (em Microsoft.VisualStudio.VCCodeModel.dll)

Sintaxe

'Declaração
Function AddMacro ( _
    Name As String, _
    Location As Object, _
    Value As String, _
    Position As Object _
) As VCCodeMacro

VCCodeMacro AddMacro(
    string Name,
    Object Location,
    string Value,
    Object Position
)

VCCodeMacro^ AddMacro(
    String^ Name, 
    Object^ Location, 
    String^ Value, 
    Object^ Position
)

abstract AddMacro : 
        Name:string * 
        Location:Object * 
        Value:string * 
        Position:Object -> VCCodeMacro

function AddMacro(
    Name : String, 
    Location : Object, 
    Value : String, 
    Position : Object
) : VCCodeMacro

Parâmetros

Name
Tipo: String

Obrigatório. Especifica o nome de macro.

Location
Tipo: Object

Obrigatório. O caminho ou o nome do arquivo a ser alterado. Se o arquivo não existir, ele é criado automaticamente. O arquivo é adicionado ao projeto se ele não for um item de projeto. Se o arquivo não pode ser criado e adicionado ao projeto, então o AddMacro falhar.

Value
Tipo: String

Opcional. O texto da definição de macro.

Position
Tipo: Object

Opcional. Opção = 0. O elemento de código após o qual para adicionar o novo elemento. Se o valor é CodeElement, então o novo elemento é adicionado imediatamente depois deles.

Como as coleções inicia a contagem em uma, passe 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: Microsoft.VisualStudio.VCCodeModel.VCCodeMacro
Um objeto VCCodeMacro.

Comentários

Chamar essa função para adicionar um elemento de Diretiva #define (C/C++) para o arquivo especificado.

Consulte Como compilar um código de exemplo para extensibilidade do modelo de código do Visual C++ para obter informações sobre como criar e executar esse exemplo.

Exemplos

Este exemplo adiciona uma instrução macro para o arquivo de stdafx.h.

Sub AddMacro()
    Dim codeModel As VCCodeModel
    codeModel = DTE.Solution.Item(1).CodeModel
    Dim macro As VCCodeMacro
    macro = codeModel.AddMacro("LAST_CHAR", "File.h", "'Z'")
End Sub

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.

Consulte também

Referência

VCCodeModel Interface

Namespace Microsoft.VisualStudio.VCCodeModel

Compartilhar via