Switch.GetSupportedAttributes Method ()


The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Gets the custom attributes supported by the switch.

Namespace:   System.Diagnostics
Assembly:  System (in System.dll)

protected internal virtual string[] GetSupportedAttributes()

Return Value

Type: System.String[]

A string array that contains the names of the custom attributes supported by the switch, or null if there no custom attributes are supported.

The default implementation for the GetSupportedAttributes method returns null. If a switch is added in a configuration file and custom attributes are specified that are not included in the string array returned by GetSupportedAttributes, a ConfigurationException is thrown when the switch is loaded.

Notes to Inheritors:

When inheriting from the Switch class or a derived class, you can override the GetSupportedAttributes method to provide custom attributes for your class.

The following code sample shows an override of the GetSupportedAttributes method for a custom switch.

public class MySourceSwitch : SourceSwitch
    int sourceAttribute = 0;
    public MySourceSwitch(string n) : base(n) { }
    public int CustomSourceSwitchAttribute
            foreach (DictionaryEntry de in this.Attributes)
                if (de.Key.ToString().ToLower() == "customsourceswitchattribute")
                    sourceAttribute = (int)de.Value;
            return sourceAttribute;
        set { sourceAttribute = (int)value; }

    protected override string[] GetSupportedAttributes()
        return new string[] { "customsourceSwitchattribute" };

.NET Framework
Available since 2.0
Return to top