VCCodeModel.AddMacro - метод

Статья
05/17/2015

Добавляет элемент #define в определенный файл.

Пространство имен: Microsoft.VisualStudio.VCCodeModel
Сборка: Microsoft.VisualStudio.VCCodeModel (в Microsoft.VisualStudio.VCCodeModel.dll)

Синтаксис

'Декларация
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

Параметры

Name
Тип: String

Обязательный. Указывает имя макроса.

Location
Тип: Object

Обязательный. Путь или имя изменяемого файла. Если файл не существует, он создается автоматически. Файл добавляется к проекту, если он не является его частью. Если файл не может быть создан и добавлен к проекту, метод AddMacro дает сбой.

Value
Тип: String

Необязательный. Текст определения макроса.

Position
Тип: Object

Необязательный. Значение по умолчанию: 0 Элемент кода, после которого добавляется новый элемент. Если значением является CodeElement, новый элемент добавляется непосредственно после него.

Поскольку в коллекциях нумерация элементов начинается с 1, передача значения 0 означает, что новый элемент следует поместить в начало коллекции. Значение -1 означает, что элемент следует поместить в конец.

Возвращаемое значение

Тип: Microsoft.VisualStudio.VCCodeModel.VCCodeMacro
Объект VCCodeMacro.

Заметки

Вызов этой функции, чтобы добавить элемент Директива #define (C/C++) в указанный файл.

Дополнительные сведения по компиляции и выполнению этого примера см. в разделе Практическое руководство. Компиляция примера кода для расширения модели кода Visual C++.

Примеры

Этот пример добавляет выписка макроса в файл 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

Безопасность платформы .NET Framework

Полное доверие для непосредственно вызывающего метода. Этот член не может быть использован частично доверенным кодом. Для получения дополнительной информации см. Использование библиотек из не вполне надежного кода.

См. также

Ссылки

VCCodeModel Интерфейс

Microsoft.VisualStudio.VCCodeModel - пространство имен

Поделиться через