This documentation is archived and is not being maintained.

Switch.GetSupportedAttributes Method

Gets the custom attributes supported by the switch.

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

protected internal virtual string[] GetSupportedAttributes ()
protected String[] GetSupportedAttributes ()
protected internal function GetSupportedAttributes () : String[]
Not applicable.

Return Value

A string array that contains the names of the custom attributes supported by the switch, or a null reference (Nothing in Visual Basic) if there no custom attributes are supported.

The default implementation for the GetSupportedAttributes method returns a null reference (Nothing in Visual Basic). 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
    {
        get
        {
            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" };
    }
}

Windows 98, Windows Server 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0
Show: