CodeModel2.AddFunction Method

[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]

Creates a new function code construct and inserts the code in the correct location.

Namespace:  EnvDTE80
Assembly:  EnvDTE80 (in EnvDTE80.dll)

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


Type: System.String

Required. The name of the new function.

Type: System.Object

Required. The path and file name for the new function definition. Depending on the language, the file name is either relative or absolute to the project file. The file is added to the project if it is not already a project item. If the file cannot be created and added to the project, then AddFunction fails.

Type: EnvDTE.vsCMFunction

Required. The vsCMFunction constant indicating the type of function, such as whether the function is a property-get, a method, and so forth.

Type: System.Object

Required. A vsCMTypeRef constant indicating the data type that the function returns. This can be a CodeTypeRef object, a vsCMTypeRef constant, or a fully qualified type name.

Type: System.Object

Optional. Default = 0. The code element after which to add the new element. If the value is a CodeElement, then the new element is added immediately after it.

If the value is a Long data type, then AddFunction indicates the element after which to add the new element.

Because collections begin their count at 1, passing 0 indicates that the new element should be placed at the beginning of the collection. A value of -1 means the element should be placed at the end.

Type: EnvDTE.vsCMAccess

Optional. A vsCMAccess constant.

Return Value

Type: EnvDTE.CodeFunction
A CodeFunction object.

You might add an overload operator (using vsCMFunctionOperator) as in the following example.

Sub testAddOverloadOperatorCPP()

Dim fcm As FileCodeModel = _


Dim cc As CodeClass = fcm.CodeElements.Item("someClassName")

cc.AddFunction("+", vsCMFunction.vsCMFunctionOperator, _


'cc.AddFunction("someFunction +", _

vsCMFunction.vsCMFunctionFunction, vsCMTypeRef.vsCMTypeRefInt)

End Sub

In this case, you must explicitly specify the name of the function you want to overload (in this example, "someFunction") in the call to AddFunction, not just the overload operator itself. Using the above code as an example,

cc.AddFunction("+", vsCMFunction.vsCMFunctionOperator,...)

does not work. You must instead use

cc.AddFunction("someFunction +", vsCMFunction.vsCMFunctionFunction,...)

Only Visual C++ implements this method because C#, Visual Basic, and J# do not allow top-level functions.

Native Visual C++ requires the colon-separated (::) format for its fully qualified type names.


The values of code model elements such as classes, structs, functions, attributes, delegates, and so forth can be non-deterministic after making certain kinds of edits, meaning that their values cannot be relied upon to always remain the same. For more information, see the section Code Model Element Values Can Change in Discovering Code by Using the Code Model (Visual Basic).

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

        // Create a new function.
        cm.AddFunction("TestFunction", projItem.Name, _
            vsCMFunction.vsCMFunctionFunction, _
            vsCMTypeRef.vsCMTypeRefInt, -1, _
    catch (Exception ex)

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
© 2014 Microsoft