This documentation is archived and is not being maintained.

AddDelegate Method [Variation 2] (General Extensibility}

Visual Studio .NET 2003

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

Note   AddDelegate may not be supported by all languages. This method is not supported for Visual Basic.
[Visual Basic .NET]
Public Function AddDelegate( _
   Name As String, _
   Location As Variant, _
   Type As Variant, _
   Position As Variant, _
   Optional Access As vsCMAccess = vsCMAccessDefault _
) As CodeDelegate
[Visual Basic 6]
Function AddDelegate( _
   Name As String, _
   Location As Variant, _
   Type As Variant, _
   Position As Variant, _
   Optional Access As vsCMAccess = vsCMAccessDefault _
) As CodeDelegate
[C++]
HRESULT __stdcall AddDelegate(
   BSTR Name,
   VARIANT Location,
   VARIANT Type,
   VARIANT Position,
   vsCMAccess Access,
   /* [out, retval] */ CodeDelegate** retVal
);
[C#]
CodeDelegate AddDelegate(
   string Name,
   object Location,
   object Type,
   object Position,
   vsCMAccess Access
);
[JScript .NET]
public 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 filename for the new delegate definition. Depending on the language, the filename 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 Long, 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

Returns a CodeDelegate object.

Remarks

All languages support a period-separated format for the fully qualified type name, but some languages also support another particular format, such as a colon-separated (::) elements for Visual C++ .NET.

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

See Also

Applies To: CodeModel Object | VCCodeModel Object

Show: