Merge pinvoke guidelines into interop guidelines #34833
Conversation
|
|
||
| If you *do* use `StringBuilder` one last gotcha is that the capacity does **not** include a hidden null which is always accounted for in interop. It is pretty common for people to get this wrong as most APIs want the size of the buffer *including* the null. This can result in wasted/unnecessary allocations. | ||
|
|
||
| **[USE]** Char arrays from `ArrayPool` or `StringBuffer` or `stackalloc` |
There was a problem hiding this comment.
I added stackalloc here. Probably, we should explicitly talk about buffer allocation in general (not just char buffers)
|
|
||
| Interop signatures / structs / constants should be defined using the same name / capitalization / etc. that's used in the corresponding native code. We should not rename any of these based on managed coding guidelines. The only exception to this is for the constant grouping type, which should be named with the most discoverable name possible; if that name is a concept (e.g. Errors), it can be named using managed naming guidelines. |
There was a problem hiding this comment.
I left this bit in as the doc only recommends constants be named this way.
There was a problem hiding this comment.
BTW that topic probably should mention stackalloc given how often we use it for interop buffers. And suggest a max size.
There was a problem hiding this comment.
The doc has the recommendation for everything. It just has the text about the constant grouping type replaced with "CONSIDER" recommendation (vs. DO recommendation for method names) .
DO use the same naming and capitalization for your methods and parameters as the native method you want to call.
CONSIDER using the same naming and capitalization for constant values.
There was a problem hiding this comment.
There is a whole chapter on the constant grouping types before this one.
There was a problem hiding this comment.
Right - we were saying "should" vs the doc just says CONSIDER. I am happy to remove it though.
ghost
locked as resolved and limited conversation to collaborators
Fixes #304
I separated out some edits and the merge.