CodeModel2.AddEnum 方法 (String, Object, Object, Object, vsCMAccess)

2008-09-04

更新：2007 年 11 月

创建新的枚举代码构造，并将代码插入正确的位置。

命名空间： EnvDTE80
程序集： EnvDTE80（在 EnvDTE80.dll 中）

语法

声明
Function AddEnum ( _
    Name As String, _
    Location As Object, _
    Position As Object, _
    Bases As Object, _
    Access As vsCMAccess _
) As CodeEnum
用法
Dim instance As CodeModel2
Dim Name As String
Dim Location As Object
Dim Position As Object
Dim Bases As Object
Dim Access As vsCMAccess
Dim returnValue As CodeEnum

returnValue = instance.AddEnum(Name, Location, _
    Position, Bases, Access)

CodeEnum AddEnum(
    string Name,
    Object Location,
    Object Position,
    Object Bases,
    vsCMAccess Access
)

CodeEnum^ AddEnum(
    String^ Name, 
    Object^ Location, 
    Object^ Position, 
    Object^ Bases, 
    vsCMAccess Access
)

function AddEnum(
    Name : String, 
    Location : Object, 
    Position : Object, 
    Bases : Object, 
    Access : vsCMAccess
) : CodeEnum

参数

Name
类型：System.String

必选。要添加的枚举的名称。

Location
类型：System.Object

必选。新枚举定义的路径和文件名。根据语言的不同，文件名是项目文件的相对名称或绝对名称。如果该文件还不是项目项，则将该文件添加到项目中。如果无法创建该文件并将其添加到项目中，则 AddEnum 失败。

Position
类型：System.Object

可选。默认为 0。将在其后添加新元素的代码元素。如果该值为 CodeElement，则紧跟在其后添加新元素。

如果该值为 Long 数据类型，则 AddEnum 指示在哪个元素后添加新元素。

因为集合从 1 开始计数，所以传递 0 指示应将新元素放置在集合的开始处。值为 -1 表示应将元素放在结尾处。

Bases
类型：System.Object

可选。默认为 Nothing。一个保存 SafeArray 的变量，该 SafeArray 包含用于指定新建枚举的基础类型的完全限定类型名或 CodeType 对象。

Access
类型：EnvDTE.vsCMAccess

可选。一个 vsCMAccess 常数。

返回值

类型：EnvDTE.CodeEnum

一个 CodeEnum 对象。

实现

CodeModel.AddEnum(String, Object, Object, Object, vsCMAccess)

备注

参数正确与否由代码模型后面的语言决定。所有语言都忽略 Bases 参数。

说明：
在进行某些类型的编辑之后，代码模型元素（如类、结构、函数、属性、委托等）的值可能是非确定性的，这意味着不能指望它们的值总是保持不变。有关更多信息，请参见使用代码模型查找代码 (Visual Basic) 中的“代码模型元素的值可能会更改”一节。

示例

Sub AddEnumExample2(ByVal dte As DTE2)

    ' Before running this example, open a code document from a project.
    Try
        Dim projItem As ProjectItem = dte.ActiveDocument.ProjectItem
        Dim cm As CodeModel = projItem.ContainingProject.CodeModel

        ' Create a new enum.
        cm.AddEnum("TestEnum", projItem.Name)
    Catch ex As Exception
        MsgBox(ex.Message)
    End Try

End Sub

public void AddEnumExample2(DTE2 dte)
{
    // Before running this example, open a code document from 
    // a project.
    try
    {
        ProjectItem projItem = dte.ActiveDocument.ProjectItem;
        CodeModel cm = projItem.ContainingProject.CodeModel;

        // Create a new enum.
        cm.AddEnum("TestEnum", projItem.Name, -1, null, 
            vsCMAccess.vsCMAccessPublic);
    }
    catch (Exception ex)
    {
        MessageBox.Show(ex.Message);
    }
}