CodeStruct.AddFunction - метод

Статья
11/05/2008

Обновлен: Ноябрь 2007

Создает новую конструкцию кода функции и вставляет код в нужное место.

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

Синтаксис

'Декларация
Function AddFunction ( _
    Name As String, _
    Kind As vsCMFunction, _
    Type As Object, _
    Position As Object, _
    Access As vsCMAccess, _
    Location As Object _
) As CodeFunction
'Применение
Dim instance As CodeStruct
Dim Name As String
Dim Kind As vsCMFunction
Dim Type As Object
Dim Position As Object
Dim Access As vsCMAccess
Dim Location As Object
Dim returnValue As CodeFunction

returnValue = instance.AddFunction(Name, _
    Kind, Type, Position, Access, Location)

CodeFunction AddFunction(
    string Name,
    vsCMFunction Kind,
    Object Type,
    Object Position,
    vsCMAccess Access,
    Object Location
)

CodeFunction^ AddFunction(
    String^ Name, 
    vsCMFunction Kind, 
    Object^ Type, 
    Object^ Position, 
    vsCMAccess Access, 
    Object^ Location
)

function AddFunction(
    Name : String, 
    Kind : vsCMFunction, 
    Type : Object, 
    Position : Object, 
    Access : vsCMAccess, 
    Location : Object
) : CodeFunction

Параметры

Name
Тип: System.String
Обязательный. Имя новой функции.

Kind
Тип: EnvDTE.vsCMFunction
Обязательный. Константа vsCMFunction, указывающая тип функции, например, является ли она функцией возврата значения свойства или методом.

Type
Тип: System.Object
Обязательный. Константа vsCMTypeRef, указывающая тип возвращаемых функцией данных. Это может быть объект CodeTypeRef, константа vsCMTypeRef или полное имя типа.

Position
Тип: System.Object
Необязательный. По умолчанию = 0. Элемент кода, после которого вставляется новый элемент. Если значение CodeElement, новый элемент добавляется непосредственно после него.
Если значение имеет тип данных Long, AddFunction указывает, после какого элемента следует добавить новый элемент.
Поскольку в коллекциях нумерация элементов начинается с 1, значение 0 означает, что новый элемент следует поместить в начало коллекции. Значение -1 означает, что элемент следует поместить в конец.

Access
Тип: EnvDTE.vsCMAccess
Необязательный. Константа vsCMAccess.

Location
Тип: System.Object
Необязательный. Путь и имя файла для нового определения. В зависимости от языка путь к файлу проекта может быть либо относительным, либо абсолютным. Файл добавляется к проекту, если он не является его частью. Если файл не может быть создан и добавлен к проекту, тогда AddFunction дает сбой.

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

Тип: EnvDTE.CodeFunction
Объект CodeFunction.

Заметки

Для полных имен типов в Visual C++ необходимо использовать формат с разделителем в виде двух двоеточий (::). Все остальные языки поддерживают формат с разделителем-точкой.

Правильность аргументов определяется языком, на котором основана модель кода.

Примечание.
Значения элементов модели кода, таких как классы, структуры, функции, атрибуты, делегаты и другие, после внесения некоторых изменений могут оказаться недетерминированными, другими словами, нельзя рассчитывать, что их значения будут всегда оставаться одинаковыми. Дополнительные сведения см. в разделе "Значения элементов модели кода могут изменяться" раздела Практическое руководство. Поиск кода при помощи модели кода (Visual Basic).

Значения элементов модели кода, таких как классы, структуры, функции, атрибуты, делегаты и другие, после внесения некоторых изменений могут оказаться недетерминированными, другими словами, нельзя рассчитывать, что их значения будут всегда оставаться одинаковыми. Дополнительные сведения см. в разделе "Значения элементов модели кода могут изменяться" раздела Практическое руководство. Поиск кода при помощи модели кода (Visual Basic).

Разрешения

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