Do you know Optional Parameters?

category: [ Just Coding ] tags: [ CSharp ] [ Language Features ]
created: 07 Jul 2014 @ 19:40 modified: 24 Apr 2017 @ 13:57

Up until about an hour ago I thought I knew how optional parameters worked but didn't actually. I thought (probably without giving it too much thought) that optional parameters would compile to something that would reflect having multiple overloads as when they came out I ripped out 100s of overloads across multiple libraries and replaces them with optional parameters because it replace code like


with code like


It's obviously that the second snippet is easier to read but do you know what's actually happening?

Andrew Clymer mentioned mentioned in training today that optional parameters are compiled into the calling code and not the method where they are used and thought this is something that others might not have known as well Smile

See below for a quick example of this. Create a new Console Application and Class Library as below


If you run this you will see in a console window the message Hello with some underscores.


This is what we expect and there is nothing unusual there but what happens if we change the code for the Utils class like below


Now build only the class library, copy the output assembly (CalcLibrary.dll) to the console windows output directory and then run the console window from windows explorer


You'll notice that again we see what we expect. Now change your Utils class to have underscores as a default in a name parameter and place that in the return string like this


Again if you run this you will get what you expect


Now lets make that second change we did and replace the underscores with a underscore dash repeated 5 times like so


Build just the class library, copy the assembly over and run the console app in windows explorer and you'll see that the nothing changed in the console window


I recently watch Bart De Smet's Pluralsight videos (C# Language Internals - Part 1 | C# Language Internals - Part 2) and one thing I realized is that I thought I knew stuff and to almost truly know you should check the IL or view the IL in a nice tool like IL Spy. So I opened the code in IL Spy and took a look at the class library to make sure that it update and as expected it did


and to then opened the program class in the class library and found that the code that the console app was compiled against had been added to the call to Utils.GetMessage


In this example there is nothing that could go wrong and you probably would worry about the behavior of the optional parameter but there will be cases in more important code where this could be a problem maybe for performance or even security I'm guessing.


Gordon Beeming works at Nologo Studios in the sunny city of Durban, South Africa. He is the Lead for the Data and Services Team and has a strong focus on Developer Efficiencies and R&D. When he's not hacking away at a keyboard in Visual Studio he'll generally be relaxing with his family or hitting the black top getting in some mileage. He is a Visual Studio ALM Ranger and Visual Studio ALM MVP.

Follow me on Strava


I plan on writing a bunch of online tools and sharing the code for how I made those tools. If you have any feedback you can ping me on Twitter (@GordonBeeming) or mail me [email protected].