Skip to content

Interop doc issues #7436

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Dec 3, 2021
Merged

Interop doc issues #7436

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5aac6d3
Update Marshal.PtrToStructure doc.
AaronRobinsonMSFT Nov 26, 2021
26a6131
Document support is missing on non-Windows and Mono runtime.
AaronRobinsonMSFT Nov 29, 2021
df0fea3
Apply suggestions from code review
AaronRobinsonMSFT Dec 1, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion xml/System.Runtime.InteropServices/DefaultDllImportSearchPathsAttribute.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,8 @@
2. Otherwise, if the attribute is applied to the assembly that contains the platform invoke, use the values specified by that instance of the attribute.

3. Otherwise, search the assembly directory and then call the `LoadLibraryEx` function with the `LOAD_WITH_ALTERED_SEARCH_PATH` flag.


This attribute has no effect on non-Windows platforms or the Mono runtime.
]]></format>
</remarks>
<altmember cref="T:System.Runtime.InteropServices.DllImportSearchPath" />
Expand Down
8 changes: 4 additions & 4 deletions xml/System.Runtime.InteropServices/Marshal.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7316,7 +7316,7 @@ On .NET 6 and later versions, this method is functionally equivalent to <xref:Sy

## Remarks
<xref:System.Runtime.InteropServices.Marshal.PtrToStructure%2A> is often necessary in COM interop and platform invoke when structure parameters are represented as an <xref:System.IntPtr?displayProperty=nameWithType> value. You cannot use this overload method with value types.
If the `ptr` parameter equals <xref:System.IntPtr.Zero?displayProperty=nameWithType>, `null` will be returned.
]]></format>
</remarks>
<exception cref="T:System.ArgumentException">Structure layout is not sequential or explicit.
Expand Down Expand Up @@ -7395,7 +7395,7 @@ On .NET 6 and later versions, this method is functionally equivalent to <xref:Sy

## Remarks
<xref:System.Runtime.InteropServices.Marshal.PtrToStructure%2A> is often necessary in COM interop and platform invoke when structure parameters are represented as an <xref:System.IntPtr?displayProperty=nameWithType> value. You can pass a value type to this overload method. In this case, the returned object is a boxed instance.
If the `ptr` parameter equals <xref:System.IntPtr.Zero?displayProperty=nameWithType>, `null` will be returned.


## Examples
Expand Down Expand Up @@ -7490,7 +7490,7 @@ On .NET 6 and later versions, this method is functionally equivalent to <xref:Sy

## Remarks
<xref:System.Runtime.InteropServices.Marshal.PtrToStructure%60%601%28System.IntPtr%29> is often necessary in COM interop and platform invoke when structure parameters are represented as <xref:System.IntPtr?displayProperty=nameWithType> values. You can pass a value type to this method overload.
If the `ptr` parameter equals <xref:System.IntPtr.Zero?displayProperty=nameWithType>, `null` will be returned.
]]></format>
</remarks>
<exception cref="T:System.ArgumentException">The layout of <typeparamref name="T" /> is not sequential or explicit.</exception>
Expand Down Expand Up @@ -7555,7 +7555,7 @@ On .NET 6 and later versions, this method is functionally equivalent to <xref:Sy

## Remarks
<xref:System.Runtime.InteropServices.Marshal.PtrToStructure%60%601%28System.IntPtr%2C%60%600%29> is often necessary in COM interop and platform invoke when structure parameters are represented as <xref:System.IntPtr> values. You cannot use this method overload with value types.
If the `ptr` parameter equals <xref:System.IntPtr.Zero?displayProperty=nameWithType>, `null` will be returned.
]]></format>
</remarks>
<exception cref="T:System.ArgumentException">Structure layout is not sequential or explicit.</exception>
Expand Down