Export (0) Print
Expand All
Cut
Run
Expand Minimize

AddFunction Method [Variation 1] (General Extensibility)

Visual Studio .NET 2003

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

Note   AddFunction may not be supported by all languages. This method is not supported for Visual Basic .NET.
[Visual Basic .NET]
Public Function AddFunction( _
   Name As String, _
   Kind As vsCMFunction, _
   Type As Variant, _
   Position As Variant, _
   Optional Access As vsCMAccess = vsCMAccessDefault, _
   Optional Location As Variant _
) As CodeFunction
[Visual Basic 6]
Function AddFunction( _
   Name As String, _
   Kind As vsCMFunction, _
   Type As Variant, _
   Position As Variant, _
   Optional Access As vsCMAccess = vsCMAccessDefault, _
   Optional Location As Variant _
) As CodeFunction
[C++]
HRESULT __stdcall AddFunction(
   BSTR Name,
   vsCMFunction Kind,
   VARIANT Type,
   VARIANT Position,
   vsCMAccess Access,
   VARIANT Location,
   /* [out, retval] */ CodeFunction** retVal
);
[C#]
CodeFunction AddFunction(
   string Name,
   vsCMFunction Kind,
   object Type,
   object Position,
   vsCMAccess Access,
   object Location
);
[JScript .NET]
public function AddFunction(
   Name : String,
   Kind : vsCMFunction,
   Type : Object,
   Position : Object,
   Access : vsCMAccess,
   Location : Object
) : CodeFunction

Parameters

Name
Required. The name of the new function.
Kind
Required. The vsCMFunction constant indicating the type of function, such as whether the function is a property-get, a method, and so forth.
Type
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.
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 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.

Access
Optional. A vsCMAccess constant.
Location
Optional. The path and filename for the new function 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 AddFunction fails.

Return Value

Returns a CodeFunction 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: CodeClass Object | CodeModel Object | CodeStruct Object | VCCodeClass Object | VCCodeModel Object | VCCodeStruct Object | VCCodeUnion Object

Show:
© 2014 Microsoft