EN CSharp Keyword when filter condition

Українська · Русский · English · Deutsch · Français · Italiano · Español · 繁體中文 · 日本語 · 한국어

C#: when is the filter condition

Handbook C# · Practical Guide

Filters a catch exception or adds a condition to the pattern matching branch.

Simple example (Example.cs)

Save this example separately as Example.cs. Run it independently of the other examples on this page.

Example.cs:

// PROJECT-EXAMPLE
try { throw new System.Exception("sample"); }
catch (System.Exception error) when (error.Message == "sample")
{
    System.Console.WriteLine("Matched");
}

Result:

Matched

Syntax

catch (Exception e) when (condition) / case pattern when condition:

Example 1: simple form

using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading;
using System.Threading.Tasks;
using System.IO;
using System.Runtime.InteropServices;
using System.Runtime.CompilerServices;

public static class Program
{
    public static async Task Main(string[] args)
    {
        try { throw new ArgumentException("sample", "count"); }
        catch (ArgumentException error) when (error.ParamName == "count") { Console.WriteLine("Handled count"); }
    }
}

Example 2: another practical form

using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading;
using System.Threading.Tasks;
using System.IO;
using System.Runtime.InteropServices;
using System.Runtime.CompilerServices;

public static class Program
{
    public static async Task Main(string[] args)
    {
        object value = 20;
        switch (value) { case int number when number > 10: Console.WriteLine("Large"); break; case int: Console.WriteLine("Small"); break; }
    }
}

Official source: Microsoft Learn.