Update StringBuilder documentation to be consistent about internal buffer copying#25003
Merged
Update StringBuilder documentation to be consistent about internal buffer copying#25003
Conversation
…ffer copying StringBuilder marshalling always copies the buffer to ensure that there is a null terminator at the end. It never reuses the internal buffer directly.
elinor-fung
reviewed
Jul 6, 2021
Member
elinor-fung
left a comment
There was a problem hiding this comment.
Should we also clarify the wording in the other doc the issue pointed at (https://docs.microsoft.com/dotnet/framework/interop/default-marshaling-for-strings#fixed-length-string-buffers: 'A StringBuilder can be dereferenced and modified by the callee') to indicate that it is a copy of the internal buffer?
Co-authored-by: Elinor Fung <elfung@microsoft.com>
elinor-fung
approved these changes
Jul 6, 2021
Contributor
|
@elinor-fung @jkoritzinsky Just to doublecheck, this content was written for .NET Framework, but I assume it applies to both .NET and .NET Framework? |
Member
Author
|
Yes this applies to both. We have some other documentation in the shared folder that’s already been updated. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
StringBuilder marshalling always copies the buffer to ensure that there is a null terminator at the end. It never reuses the internal buffer directly.
Fixes dotnet/runtime#47735