VCCodeModel.AddMacro (Método)

Agrega un elemento #define a un archivo determinado.

Espacio de nombres:  Microsoft.VisualStudio.VCCodeModel
Ensamblado:  Microsoft.VisualStudio.VCCodeModel (en Microsoft.VisualStudio.VCCodeModel.dll)

Sintaxis

'Declaración
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

  Obligatorio. Especifica el nombre de la macro.

• Location
  Tipo: Object

  Obligatorio. Ruta de acceso o nombre del archivo que se va a modificar. Si el archivo no existe, se creará automáticamente. El archivo se agregará al proyecto si todavía no es un elemento del mismo. Si no es posible crear el archivo y agregarlo al proyecto, AddMacro producirá un error.

• Value
  Tipo: String

  Opcional. Texto de la definición de la macro.

• Position
  Tipo: Object

  Opcional. Valor predeterminado = 0. Elemento de código tras el que se agrega el elemento nuevo. Si el valor es un CodeElement, el nuevo elemento se agregará inmediatamente tras él.

  Como el recuento de los elementos de una colección comienza en uno, pasar un valor 0 indica que el nuevo elemento deberá colocarse al principio de la colección. Un valor de -1 indica que el elemento deberá situarse al final de la colección.

Valor devuelto

Tipo: Microsoft.VisualStudio.VCCodeModel.VCCodeMacro
Objeto VCCodeMacro.

Comentarios

Llame a esta función para agregar un elemento de #define (Directiva) (C/C++) al archivo especificado.

Vea Cómo: Compilar el código de ejemplo de extensibilidad del modelo de código de Visual C++ para obtener información sobre cómo compilar y ejecutar este ejemplo.

Ejemplos

Este ejemplo agrega una instrucción de macro en el archivo 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

Seguridad de .NET Framework

• Plena confianza para el llamador inmediato. Un código de confianza parcial no puede utilizar este miembro. Para obtener más información, vea Utilizar bibliotecas de código que no es de plena confianza.

Vea también

Referencia

VCCodeModel Interfaz

Microsoft.VisualStudio.VCCodeModel (Espacio de nombres)