VCCodeModel.AddFunction Method (String, Object, vsCMFunction, Object, Object, vsCMAccess)


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

Namespace:   Microsoft.VisualStudio.VCCodeModel
Assembly:  Microsoft.VisualStudio.VCCodeModel (in Microsoft.VisualStudio.VCCodeModel.dll)

CodeFunction AddFunction(
	string Name,
	object Location,
	vsCMFunction Kind,
	object Type,
	object Position,
	vsCMAccess Access = vsCMAccess.vsCMAccessDefault


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, 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.

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

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

Return to top