CodeClass2.AddFunction Method

Reference

Definition

Namespace:: EnvDTE80

Assembly:: EnvDTE80.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.12.40391

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Creates a new function in the class.

EnvDTE::CodeFunction AddFunction(std::wstring const & Name, EnvDTE::vsCMFunction Kind, winrt::Windows::Foundation::IInspectable const & Type, winrt::Windows::Foundation::IInspectable const & Position, EnvDTE::vsCMAccess Access = EnvDTE.vsCMAccess.vsCMAccessDefault, winrt::Windows::Foundation::IInspectable const & Location);

[System.Runtime.InteropServices.DispId(64)]
public EnvDTE.CodeFunction AddFunction (string Name, EnvDTE.vsCMFunction Kind, object Type, object Position, EnvDTE.vsCMAccess Access = EnvDTE.vsCMAccess.vsCMAccessDefault, object Location);

[<System.Runtime.InteropServices.DispId(64)>]
abstract member AddFunction : string * EnvDTE.vsCMFunction * obj * obj * EnvDTE.vsCMAccess * obj -> EnvDTE.CodeFunction

Public Function AddFunction (Name As String, Kind As vsCMFunction, Type As Object, Optional Position As Object, Optional Access As vsCMAccess = EnvDTE.vsCMAccess.vsCMAccessDefault, Optional Location As Object) As CodeFunction

Parameters

Name: String

Required. The name of the new function.

Kind: vsCMFunction

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

Type: 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.

Position: Object

Optional. Default = 0. The code element after which to add the new function.

If the value is a Long, then Position 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 function should be placed at the end.

Access: vsCMAccess

Optional. A vsCMAccess constant.

Location: Object

Optional. Location of the new function.

Returns

CodeFunction

A CodeFunction object.

Implements

AddFunction(String, vsCMFunction, Object, Object, vsCMAccess, Object)

Attributes: DispIdAttribute

Examples

[Visual Basic]

Sub AddFunctionExample2(ByVal dte As DTE2)  
    ' Before running this example, open a code document from a project  
    ' and place the insertion point inside a class definition.  
    Try  
        ' Retrieve the CodeClass at the insertion point.  
        Dim sel As TextSelection = _  
            CType(dte.ActiveDocument.Selection, TextSelection)  
        Dim cls As CodeClass = _  
            CType(sel.ActivePoint.CodeElement( _  
            vsCMElement.vsCMElementClass), CodeClass)  

        ' Create a new member function.  
        cls.AddFunction("TestFunction", _  
            vsCMFunction.vsCMFunctionFunction, _  
            vsCMTypeRef.vsCMTypeRefInt)  
    Catch ex As Exception  
        MsgBox(ex.Message)  
    End Try  
End Sub

[C#]

public void AddFunctionExample2(DTE2 dte)  
{  
    // Before running this example, open a code document from a project  
    // and place the insertion point inside a class definition.  
    try  
    {  
        // Retrieve the CodeClass at the insertion point.  
        TextSelection sel =   
            (TextSelection)dte.ActiveDocument.Selection;  
        CodeClass cls =   
            (CodeClass)sel.ActivePoint.get_CodeElement(  
            vsCMElement.vsCMElementClass);  

        // Create a new member function.  
        cls.AddFunction("TestFunction",   
            vsCMFunction.vsCMFunctionFunction,   
            vsCMTypeRef.vsCMTypeRefInt, -1,   
            vsCMAccess.vsCMAccessDefault, null);  
    }  
    catch (Exception ex)  
    {  
        MessageBox.Show(ex.Message);  
    }  
}

Remarks

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

Note

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

Applies to

Partilhar via