Skip to content

Update NativeLibrary.xml #11661

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

Closed
wants to merge 1 commit into from
Closed

Update NativeLibrary.xml #11661

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
44 changes: 22 additions & 22 deletions xml/System.Runtime.InteropServices/NativeLibrary.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,12 +133,12 @@ Calling this method with an invalid `handle` parameter other than <xref:System.I
</Docs>
</Member>
<Member MemberName="Load">
<MemberSignature Language="C#" Value="public static IntPtr Load (string libraryPath);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig native int Load(string libraryPath) cil managed" />
<MemberSignature Language="C#" Value="public static IntPtr Load (string executableName);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig native int Load(string executableName) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Runtime.InteropServices.NativeLibrary.Load(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Shared Function Load (libraryPath As String) As IntPtr" />
<MemberSignature Language="F#" Value="static member Load : string -&gt; nativeint" Usage="System.Runtime.InteropServices.NativeLibrary.Load libraryPath" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; static IntPtr Load(System::String ^ libraryPath);" />
<MemberSignature Language="VB.NET" Value="Public Shared Function Load (executableName As String) As IntPtr" />
<MemberSignature Language="F#" Value="static member Load : string -&gt; nativeint" Usage="System.Runtime.InteropServices.NativeLibrary.Load executableName" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; static IntPtr Load(System::String ^ executableName);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Runtime.InteropServices</AssemblyName>
Expand All @@ -155,15 +155,15 @@ Calling this method with an invalid `handle` parameter other than <xref:System.I
<ReturnType>System.IntPtr</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="libraryPath" Type="System.String" />
<Parameter Name="executableName" Type="System.String" />
</Parameters>
<Docs>
<param name="libraryPath">The name of the native library to be loaded.</param>
<param name="executableName">The name of the native library to be loaded.</param>
<summary>Provides a simple API for loading a native library that wraps the OS loader and uses default flags.</summary>
<returns>The OS handle for the loaded native library.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="libraryPath" /> is <see langword="null" />.</exception>
<paramref name="executableName" /> is <see langword="null" />.</exception>
<exception cref="T:System.DllNotFoundException">The library can't be found.</exception>
<exception cref="T:System.BadImageFormatException">The library is not valid.</exception>
</Docs>
Expand Down Expand Up @@ -191,12 +191,12 @@ Calling this method with an invalid `handle` parameter other than <xref:System.I
<ReturnType>System.IntPtr</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="libraryName" Type="System.String" />
<Parameter Name="executableName" Type="System.String" />
<Parameter Name="assembly" Type="System.Reflection.Assembly" />
<Parameter Name="searchPath" Type="System.Nullable&lt;System.Runtime.InteropServices.DllImportSearchPath&gt;" />
</Parameters>
<Docs>
<param name="libraryName">The name of the native library to be loaded.</param>
<param name="executableName">The name of the native library to be loaded.</param>
<param name="assembly">The assembly loading the native library.</param>
<param name="searchPath">The search path.</param>
<summary>Provides a high-level API for loading a native library.</summary>
Expand Down Expand Up @@ -293,7 +293,7 @@ Only one resolver can be registered per assembly. Trying to register a second re
<Docs>
<param name="handle">The native library OS handle.</param>
<param name="name">The name of the exported symbol.</param>
<param name="address">When the method returns, contains the symbol address, if it exists.</param>
<param name="address">When the method returns, it contains the symbol address, if it exists.</param>
<summary>Gets the address of an exported symbol and returns a value that indicates whether the method call succeeded.</summary>
<returns>
<see langword="true" /> if the address of the exported symbol was found successfully; otherwise, <see langword="false" />.</returns>
Expand All @@ -302,7 +302,7 @@ Only one resolver can be registered per assembly. Trying to register a second re

This is a simple wrapper around OS calls and does not perform any name mangling.

Calling this method with a invalid `handle` parameter other than <xref:System.IntPtr.Zero?displayProperty=nameWithType> is not supported and will result in undefined behaviour.
Calling this method with an invalid `handle` parameter other than <xref:System.IntPtr.Zero?displayProperty=nameWithType> is not supported and will result in undefined behaviour.

]]></format>
</remarks>
Expand All @@ -311,12 +311,12 @@ Calling this method with a invalid `handle` parameter other than <xref:System.In
</Docs>
</Member>
<Member MemberName="TryLoad">
<MemberSignature Language="C#" Value="public static bool TryLoad (string libraryPath, out IntPtr handle);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig bool TryLoad(string libraryPath, [out] native int&amp; handle) cil managed" />
<MemberSignature Language="C#" Value="public static bool TryLoad (string executableName, out IntPtr handle);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig bool TryLoad(string executableName, [out] native int&amp; handle) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Runtime.InteropServices.NativeLibrary.TryLoad(System.String,System.IntPtr@)" />
<MemberSignature Language="VB.NET" Value="Public Shared Function TryLoad (libraryPath As String, ByRef handle As IntPtr) As Boolean" />
<MemberSignature Language="F#" Value="static member TryLoad : string * nativeint -&gt; bool" Usage="System.Runtime.InteropServices.NativeLibrary.TryLoad (libraryPath, handle)" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; static bool TryLoad(System::String ^ libraryPath, [Runtime::InteropServices::Out] IntPtr % handle);" />
<MemberSignature Language="VB.NET" Value="Public Shared Function TryLoad (executableName As String, ByRef handle As IntPtr) As Boolean" />
<MemberSignature Language="F#" Value="static member TryLoad : string * nativeint -&gt; bool" Usage="System.Runtime.InteropServices.NativeLibrary.TryLoad (executableName, handle)" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; static bool TryLoad(System::String ^ executableName, [Runtime::InteropServices::Out] IntPtr % handle);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Runtime.InteropServices</AssemblyName>
Expand All @@ -333,18 +333,18 @@ Calling this method with a invalid `handle` parameter other than <xref:System.In
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="libraryPath" Type="System.String" />
<Parameter Name="executableName" Type="System.String" />
<Parameter Name="handle" Type="System.IntPtr" RefType="out" />
</Parameters>
<Docs>
<param name="libraryPath">The name of the native library to be loaded.</param>
<param name="executableName">The name of the native library to be loaded.</param>
<param name="handle">When the method returns, the OS handle of the loaded native library.</param>
<summary>Provides a simple API for loading a native library and returns a value that indicates whether the operation succeeded.</summary>
<returns>
<see langword="true" /> if the native library was loaded successfully; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="libraryPath" /> is <see langword="null" />.</exception>
<paramref name="executableName" /> is <see langword="null" />.</exception>
</Docs>
</Member>
<Member MemberName="TryLoad">
Expand All @@ -370,13 +370,13 @@ Calling this method with a invalid `handle` parameter other than <xref:System.In
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="libraryName" Type="System.String" />
<Parameter Name="executableName" Type="System.String" />
<Parameter Name="assembly" Type="System.Reflection.Assembly" />
<Parameter Name="searchPath" Type="System.Nullable&lt;System.Runtime.InteropServices.DllImportSearchPath&gt;" />
<Parameter Name="handle" Type="System.IntPtr" RefType="out" />
</Parameters>
<Docs>
<param name="libraryName">The name of the native library to be loaded.</param>
<param name="executableName">The name of the native library to be loaded.</param>
<param name="assembly">The assembly loading the native library.</param>
<param name="searchPath">The search path.</param>
<param name="handle">When the method returns, the OS handle of the loaded native library.</param>
Expand Down