CodeFunction.Overloads Property

Gets a collection of overloaded methods for this item.

Namespace:  EnvDTE
Assembly:  EnvDTE (in EnvDTE.dll)

Syntax

'Declaration
ReadOnly Property Overloads As CodeElements

CodeElements Overloads { get; }

property CodeElements^ Overloads {
    CodeElements^ get ();
}

abstract Overloads : CodeElements with get

function get Overloads () : CodeElements

Property Value

Type: EnvDTE.CodeElements
A CodeElements collection.

Remarks

Overloads returns a collection of all methods with the same name that are defined textually alongside the specified code function (that is, lexically in the same class definition syntax). If IsOverloaded is False, then this collection contains only one element — the specified code function.

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

Examples

 Sub OverloadsExample(ByVal dte As DTE2)

    ' Before running this example, open a code document from a project
    ' and place the insertion point inside a function.
    Try
        ' Retrieve the CodeFunction at the insertion point.
        Dim sel As TextSelection = _
            CType(dte.ActiveDocument.Selection, TextSelection)
        Dim fun As CodeFunction = _
            CType(sel.ActivePoint.CodeElement( _
            vsCMElement.vsCMElementFunction), CodeFunction)

        Dim ovrloads As String
        If fun.IsOverloaded Then
            ' Display all the overloads.
            Dim ovrload As CodeFunction
            For Each ovrload In fun.Overloads
                ovrloads &= ovrload.Prototype( _
                    vsCMPrototype.vsCMPrototypeParamNames Or _
                    vsCMPrototype.vsCMPrototypeParamTypes Or _
                    vsCMPrototype.vsCMPrototypeType) & vbCrLf
            Next
            MsgBox(fun.Name & " has the following overloads:" & _
                vbCrLf & vbCrLf & ovrloads)
        Else
            MsgBox(fun.Name & " isn't overloaded.")
        End If
    Catch ex As Exception
        MsgBox(ex.Message)
    End Try

End Sub

 public void OverloadsExample(DTE2 dte)
{
    // Before running this example, open a code document from a project
    // and place the insertion point inside a function.
    try
    {
        // Retrieve the CodeFunction at the insertion point.
        TextSelection sel = 
            (TextSelection)dte.ActiveDocument.Selection;
        CodeFunction fun = 
            (CodeFunction)sel.ActivePoint.get_CodeElement(
            vsCMElement.vsCMElementFunction);
        string ovrloads = "";

        if (fun.IsOverloaded)
        {
            // Display all the overloads.
            foreach (CodeFunction ovrload in fun.Overloads)
            {
                ovrloads += ovrload.get_Prototype(
                    (int)(vsCMPrototype.vsCMPrototypeParamNames | 
                    vsCMPrototype.vsCMPrototypeParamTypes | 
                    vsCMPrototype.vsCMPrototypeType)) + "\n";
            }

            MessageBox.Show(fun.Name + 
                " has the following overloads:\n\n" + ovrloads);
        }
        else
        {
            MessageBox.Show(fun.Name + " isn't overloaded.");
        }
    }
    catch (Exception ex)
    {
        MessageBox.Show(ex.Message);
    }
}

.NET Framework Security

• Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

See Also

Reference

CodeFunction Interface

EnvDTE Namespace

Other Resources

How to: Compile and Run the Automation Object Model Code Examples

Discovering Code by Using the Code Model (Visual Basic)

Discovering Code by Using the Code Model (Visual C#)