VCCodeModel.AddInclude (Método)

Agrega un elemento #include a un archivo determinado.

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

Sintaxis

'Declaración
Function AddInclude ( _
    Name As String, _
    Location As Object, _
    Position As Object _
) As VCCodeInclude

VCCodeInclude AddInclude(
    string Name,
    Object Location,
    Object Position
)

VCCodeInclude^ AddInclude(
    String^ Name, 
    Object^ Location, 
    Object^ Position
)

abstract AddInclude : 
        Name:string * 
        Location:Object * 
        Position:Object -> VCCodeInclude

function AddInclude(
    Name : String, 
    Location : Object, 
    Position : Object
) : VCCodeInclude

Parámetros

• Name
  Tipo: String

  Obligatorio. Especifica el nombre (entre comillas o corchetes angulares) del archivo que se va a incluir.

• 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, AddInclude producirá un error.

• Position
  Tipo: Object

  Obligatorio. 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.VCCodeInclude
Objeto VCCodeInclude.

Comentarios

Llame a esta función para insertar un elemento de #include (Directiva) (C/C++) en el archivo especificado del objeto de VCCodeModel .

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 #include el archivo stdafx.h.

Sub AddInclude()
    Dim codeModel As VCCodeModel
    codeModel = DTE.Solution.Item(1).CodeModel
    Dim include As VCCodeInclude
    include = codeModel.AddInclude("""stdafx.h""", "File.h", 0)
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)