CodeClass2.AddVariable 方法 (String, Object, Object, vsCMAccess, Object)

2011-08-12

在类中创建新变量。

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

语法

声明
Function AddVariable ( _
    Name As String, _
    Type As Object, _
    Position As Object, _
    Access As vsCMAccess, _
    Location As Object _
) As CodeVariable

CodeVariable AddVariable(
    string Name,
    Object Type,
    Object Position,
    vsCMAccess Access,
    Object Location
)

CodeVariable^ AddVariable(
    String^ Name, 
    Object^ Type, 
    Object^ Position, 
    vsCMAccess Access, 
    Object^ Location
)

abstract AddVariable : 
        Name:string * 
        Type:Object * 
        Position:Object * 
        Access:vsCMAccess * 
        Location:Object -> CodeVariable

function AddVariable(
    Name : String, 
    Type : Object, 
    Position : Object, 
    Access : vsCMAccess, 
    Location : Object
) : CodeVariable

参数

Name
类型：System.String
必选。新变量的名称。

Type
类型：System.Object
必选。一个 vsCMTypeRef 常数，该常数指示函数返回的数据类型。它可以是 CodeTypeRef 对象、vsCMTypeRef 常数或完全限定的类型名。

Position
类型：System.Object
可选。默认值 = 0。将在其后添加新元素的代码元素。
如果该值为 Long 数据类型，则 Position 指示在哪个元素的后面添加新元素。
因为集合从 1 开始计数，所以传递 0 指示应将新元素放置在集合的开始处。值为 -1 表示应将元素放在结尾处。

Access
类型：EnvDTE.vsCMAccess
可选。一个 vsCMAccess 常数。

Location
类型：System.Object
可选。新变量定义的路径和文件名。根据语言的不同，文件名是项目文件的相对名称或绝对名称。如果该文件还不是项目项，则将该文件添加到项目中。如果无法创建该文件并将其添加到项目中，则 AddVariable 失败。

返回值

类型：EnvDTE.CodeVariable
一个 CodeVariable 对象。

实现

CodeClass.AddVariable(String, Object, Object, vsCMAccess, Object)

备注

本机 Visual C++ 要求其完全限定类型名使用以冒号 (::) 分隔的格式。所有其他语言都支持以句点分隔的格式。

参数正确与否由代码模型后面的语言决定。

提示

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

示例

[C#]

public void CodeClass2AddVariableExample(DTE2 dte2)
    {
    // Before running this example, open a code document from a project
    // and place the insertion point inside a class definition.
    try
    {
        // Retrieve the CodeClass at the insertion point.
        TextSelection sel =
            (TextSelection)dte2.ActiveDocument.Selection;
        CodeClass2 cls =
            (CodeClass2)sel.ActivePoint.get_CodeElement(
            vsCMElement.vsCMElementClass);
        object pos = -1; // Place variable at end of members collection
        // Add variable to ActiveDocument.
        CodeVariable cvar = cls.AddVariable("TestAddVar",
            vsCMTypeRef.vsCMTypeRefFloat, pos,
            vsCMAccess.vsCMAccessProtected, null);
    }
    catch (Exception ex)
    {
        MessageBox.Show(ex.Message);
    }
}