CodeClass2.AddFunction 方法 (String, vsCMFunction, Object, Object, vsCMAccess, Object)

2011-08-12

在类中创建一个新函数。

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

语法

声明
Function AddFunction ( _
    Name As String, _
    Kind As vsCMFunction, _
    Type As Object, _
    Position As Object, _
    Access As vsCMAccess, _
    Location As Object _
) As CodeFunction

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
)

abstract AddFunction : 
        Name:string * 
        Kind:vsCMFunction * 
        Type:Object * 
        Position:Object * 
        Access:vsCMAccess * 
        Location:Object -> CodeFunction

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

参数

Name
类型：System.String
必选。新函数的名称。

Kind
类型：EnvDTE.vsCMFunction
必选。用于指示函数类型（例如，函数是属性 getter、方法还是其他类型） vsCMFunction 常数。

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

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

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

Location
类型：System.Object
可选。新函数的位置。

返回值

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

实现

CodeClass.AddFunction(String, vsCMFunction, Object, Object, vsCMAccess, Object)

备注

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

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

提示

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

示例

[Visual Basic]

Sub AddFunctionExample2(ByVal dte As 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.
        Dim sel As TextSelection = _
            CType(dte.ActiveDocument.Selection, TextSelection)
        Dim cls As CodeClass = _
            CType(sel.ActivePoint.CodeElement( _
            vsCMElement.vsCMElementClass), CodeClass)

        ' Create a new member function.
        cls.AddFunction("TestFunction", _
            vsCMFunction.vsCMFunctionFunction, _
            vsCMTypeRef.vsCMTypeRefInt)
    Catch ex As Exception
        MsgBox(ex.Message)
    End Try
End Sub

[C#]

public void AddFunctionExample2(DTE2 dte)
{
    // 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)dte.ActiveDocument.Selection;
        CodeClass cls = 
            (CodeClass)sel.ActivePoint.get_CodeElement(
            vsCMElement.vsCMElementClass);

        // Create a new member function.
        cls.AddFunction("TestFunction", 
            vsCMFunction.vsCMFunctionFunction, 
            vsCMTypeRef.vsCMTypeRefInt, -1, 
            vsCMAccess.vsCMAccessDefault, null);
    }
    catch (Exception ex)
    {
        MessageBox.Show(ex.Message);
    }
}