Optional parameters in managed C++/CLI methods

Question

How can I declare a managed method in C++/CLI that has an optional parameter when used from C#?

I've decorated the parameter with both an Optional and a DefaultParameterValue attribute (see: How default parameter values are encoded), but only the Optional attribute seems to be honored.

C++/CLI:

public ref class MyClass1
{
 public:
  MyClass1([System::Runtime::InteropServices::Optional]
           [System::Runtime::InteropServices::DefaultParameterValue(2)]
           int myParam1)                                            ↑
  {
    System::Console::WriteLine(myParam1);
  }
};

C#:

var myInstance1 = new MyClass1();  // compiles and runs

Output:

Expected Output:

Visual C# IntelliSense:

MyClass1.MyClass1([int myParam1 = 0]);  // wrong default value
                                  ↑

Edit: A closer look with a disassembler reveals that the C++/CLI compiler does indeed not generate the required .param [1] = int32(2) directive. The IL code shown by Reflector is wrong.

Reflector:

.method public hidebysig specialname rtspecialname instance void .ctor([opt] int32 myParam1) cil managed
{
    .param [1] = int32(2)  // bug
    ...

ILDASM:

.method public hidebysig specialname rtspecialname instance void .ctor([opt] int32 myParam1) cil managed
{
    .param [1]
    .custom instance void [System]System.Runtime.InteropServices.DefaultParameterValueAttribute::.ctor(object) = ( 01 00 08 02 00 00 00 00 00 ) 
    ...

Is there a reason why an overload wouldn't work, for your purposes? — Wes P, Feb 11 '11 at 21:38
@Wes P: Just aesthetical reasons. I will do overloads when I can't get this to work, but I'd prefer optional parameters if possible. — dtb, Feb 11 '11 at 21:45

score 33 · Accepted Answer · answered Feb 11 '11 at 22:00

33

The C# compiler doesn't use the [DefaultParameterValue] attribute to set the default value, it uses the .param directive to get the value embedded in the metadata. Barely documented in the CLI spec btw, only Partition II, chapter 15.4.1 mentions that it can have a FieldInit value, 15.4.1.4 is silent about it.

That's where the buck stops, the C++/CLI compiler doesn't know how to generate the directive. You cannot make this work.

answered Feb 11 '11 at 22:00

Hans Passant

922,412
146
1,693
2,536

3

Yup, bug, ildasm.exe shows you the real deal. Only the attribute is present. There's some confuzzlement there because VB.NET used the attribute, it has supported optional arguments for a long time. Your code will work with VB.NET ;) – Hans Passant Feb 11 '11 at 22:18
1

`You cannot make this work...` - challenge accepted! I bet if you used a post-build event involving something like `Mono.Cecil` that rewrote a bit of metadata would do it. Not sure if that will work with C++/CLR assemblies containing unmanaged code though. – John Leidegren Mar 24 '13 at 10:25

score 12 · Answer 2 · edited Jul 29 '20 at 07:54

12

There is a trick to make this working (workaround). the magic word is nullable, as for nullable types the default is always "null" (.HasValue == false).

Example:

C++ CLI in header:

String^ test([Optional] Nullable<bool> boolTest);

C++ CLI in .cpp file:

String^ YourClass::test(Nullable<bool> boolTest)
{
    if (!boolTest.HasValue) { boolTest = true; }
    return (boolTest ? gcnew String("True") : gcnew String("False"));
}

to Test it in C#:

MessageBox.Show(YourClass.test());

Note that [Optional] in the example above is located in the namespace System::Runtime::InteropServices. To access it, add the following line:

using namespace System::Runtime::InteropServices;

edited Jul 29 '20 at 07:54

Pooks

2,565
3
37
40

answered Sep 27 '14 at 09:01

Marcel

129
1
3

It works ! Don't care about post build steps and ildasm other re-generation tricks. :-) – TarmoPikaro Dec 11 '15 at 22:34
Lots of boxing going on here. – Brain2000 Dec 28 '18 at 06:00
1

this gives me an error `Nullable is not a template`. How to get over this? – mrid Jan 27 '20 at 07:52
Works for value types (which are not inherently nullable, I suppose), thanks! Still trying to figure it out for reference types (they are "not a valid template argument" for `Nullable` which makes sense). – Maxim Paperno Jul 01 '22 at 16:48

score 6 · Answer 3 · answered Feb 12 '11 at 00:39

6

As a workaround, you can just overload the constructor, and use delegation. It will be inlined by the JIT and should end up with the same final result as a default parameter value.

answered Feb 12 '11 at 00:39

Ben Voigt

277,958
43
419
720

Optional parameters in managed C++/CLI methods

3 Answers3

Linked