This documentation is archived and is not being maintained.

VCCodeModel.AddDelegate Method 

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

Namespace: Microsoft.VisualStudio.VCCodeModel
Assembly: Microsoft.VisualStudio.VCCodeModel (in microsoft.visualstudio.vccodemodel.dll)

CodeDelegate AddDelegate (
	string Name,
	Object Location,
	Object Type,
	[OptionalAttribute] Object Position,
	[OptionalAttribute] vsCMAccess Access
)
CodeDelegate AddDelegate (
	String Name, 
	Object Location, 
	Object Type, 
	/** @attribute OptionalAttribute() */ Object Position, 
	/** @attribute OptionalAttribute() */ vsCMAccess Access
)
function AddDelegate (
	Name : String, 
	Location : Object, 
	Type : Object, 
	Position : Object, 
	Access : vsCMAccess
) : CodeDelegate

Parameters

Name

Required. The name of the delegate to add.

Location

Required. The path and file name for the new delegate 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 AddDelegate fails.

Type

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

Position

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

Access

Optional. A vsCMAccess constant.

Return Value

A CodeDelegate object.

Visual C++ requires the colon-separated (::) format for its fully qualified type names. All other languages support the period-separated format.

The correctness of the arguments is determined by the language behind the code model.

Show: