Are P/Invoke [In, Out] attributes optional for marshaling arrays?

by

No, they are not exactly optional. It just happens to work by accident. It is however a very common accident. It works because the array doesn’t actually gets marshaled. The pinvoke marshaller sees that the C# array is already compatible with the native array so skips the step to create a copy of it. It merely pins the array and passes the pointer to the native code.

This is of course very efficient and you will inevitably get the results back because the native code is directly writing the array elements. So neither the [In] nor the [Out] attributes matter.

It gets much murkier if the array element type isn’t that simple. It isn’t that easy to identify an element type that’s a struct or class type that isn’t blittable or whose layout doesn’t match after marshaling so the pinvoke marshaller has to make a copy of the array. Especially the layout incompatibility can be very hard to identify because the managed layout is undiscoverable. And can change depending on the jitter that is used. It may work in x86 but not x64 for example, pretty nasty when AnyCPU is selected. Getting it to copy the modified copy back to the C# array does require [Out].

Not sure what to advice, other than that nobody ever got fired for being explicit in their declarations. Perhaps you should always be explicit when the array element type isn’t simple so you’ll never have an accident.

More Related Contents:

  1. C# appointing distinct array elements randomly to another array
  2. How to generate an Array of Double Arrays in c#? [duplicate]
  3. How to convert UTF-8 byte[] to string
  4. How to access random item in list?
  5. How to convert byte array to string [duplicate]
  6. Easiest way to compare arrays in C#
  7. Unable to load DLL (Module could not be found HRESULT: 0x8007007E)
  8. What is the Maximum Size that an Array can hold?
  9. How do arrays in C# partially implement IList?
  10. Any faster way of copying arrays in C#?
  11. Comparing arrays in C#
  12. Find index of a value in an array
  13. How do I get the member to which my custom attribute was applied?
  14. How to compare arrays in C#? [duplicate]
  15. Attributes in C#
  16. Show Authentication dialog in C# for windows Vista/7
  17. Difference between the System.Array.CopyTo() and System.Array.Clone()
  18. Easiest way to Rotate a List in c#
  19. C# Creating an array of arrays
  20. C# Copy Array by Value
  21. Attribute on Interface members does not work
  22. Iterate through 2 dimensional array c#
  23. How can I add my attributes to Code-Generated Linq2Sql classes properties?
  24. Why can’t I use the array initializer with an implicitly typed variable?
  25. convert string array to string
  26. How can I safely convert a byte array into a string and back? [duplicate]
  27. Is there a tool that generates P/Invoke signatures for arbitrary unmanaged DLL?
  28. How to wrap a method via attributes?
  29. How to make [DebuggerNonUserCode] hide an exception from the debugger in simple test case?
  30. Can you use “where” to require an attribute in c#?

Leave a Comment