Do you know Optional Parameters?

categories: [ 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

2014-07-07_21-38-15

with code like

2014-07-07_21-38-58

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

MyCalc_-_Microsoft_Visual_Studio_(Administrator)_2014-07-07_21-13-21

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

filecusersgordonbdocumentsvisual_studio_2_2014-07-07_21-13-50

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

2014-07-07_21-09-22

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

CUsersGordonBDocumentsvisual_studio_2013Proj_2014-07-07_21-14-55

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

2014-07-07_21-17-36

Again if you run this you will get what you expect

filecusersgordonbdocumentsvisual_studio_2_2014-07-07_21-13-50

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

2014-07-07_21-19-21

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

filecusersgordonbdocumentsvisual_studio_2_2014-07-07_21-13-50

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

2014-07-07_21-30-54

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

2014-07-07_21-32-03

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.