1 <?xml version="1.0" encoding="utf-8"?>
4 <name>System.Runtime.Loader</name>
7 <member name="T:System.Reflection.Metadata.AssemblyExtensions" />
8 <member name="M:System.Reflection.Metadata.AssemblyExtensions.TryGetRawMetadata(System.Reflection.Assembly,System.Byte*@,System.Int32@)">
9 <param name="assembly" />
11 <param name="length" />
13 <member name="T:System.Runtime.Loader.AssemblyDependencyResolver">
14 <summary>Allows a program to resolve assemblies and native libraries to paths based on the dependencies of a given assembly.</summary>
16 <member name="M:System.Runtime.Loader.AssemblyDependencyResolver.#ctor(System.String)">
17 <summary>Initializes a new instance of the <see cref="T:System.Runtime.Loader.AssemblyDependencyResolver" /> class with a path to a component's assembly.</summary>
18 <param name="componentAssemblyPath">The path to the component or plugin's managed entry point.</param>
20 <member name="M:System.Runtime.Loader.AssemblyDependencyResolver.ResolveAssemblyToPath(System.Reflection.AssemblyName)">
21 <summary>Resolves a path to an assembly with the given assembly name based on the component's dependencies.</summary>
22 <param name="assemblyName">The assembly name to resolve.</param>
23 <returns>The path to an assembly with the given name from the component's deps.json file, or <see langword="null" /> if the assembly does not exist in the deps.json file or is not on disk in the location specified by the deps.json file.</returns>
25 <member name="M:System.Runtime.Loader.AssemblyDependencyResolver.ResolveUnmanagedDllToPath(System.String)">
26 <summary>Resolves a path to a native library with the given name based on the component's dependencies.</summary>
27 <param name="unmanagedDllName">The name of the native library to resolve.</param>
28 <returns>The path to a native library with the given name from the component's deps.json file and the current runtime identifier, or <see langword="null" /> if the assembly does not exist in the deps.json file or is not on disk in the location specified by the deps.json file.</returns>
30 <member name="T:System.Runtime.Loader.AssemblyLoadContext">
31 <summary>Represents the runtime's concept of a scope for binding. This class is abstract.</summary>
33 <member name="M:System.Runtime.Loader.AssemblyLoadContext.#ctor">
34 <summary>Initializes a new instance of the <see cref="T:System.Runtime.Loader.AssemblyLoadContext" /> class.</summary>
36 <member name="M:System.Runtime.Loader.AssemblyLoadContext.#ctor(System.Boolean)">
37 <summary>Initializes a new instance of the <see cref="T:System.Runtime.Loader.AssemblyLoadContext" /> class with a value that indicates whether unloading is enabled.</summary>
38 <param name="isCollectible">
39 <see langword="true" /> to enable <see cref="M:System.Runtime.Loader.AssemblyLoadContext.Unload" />; otherwise, <see langword="false" />. The default value is <see langword="false" /> because there is a performance cost associated with enabling unloading.</param>
41 <member name="M:System.Runtime.Loader.AssemblyLoadContext.#ctor(System.String,System.Boolean)">
42 <summary>Initializes a new instance of the <see cref="T:System.Runtime.Loader.AssemblyLoadContext" /> class with a name and a value that indicates whether unloading is enabled.</summary>
43 <param name="name">The value for <see cref="P:System.Runtime.Loader.AssemblyLoadContext.Name" /> in the new instance. Its value can be <see langword="null" />.</param>
44 <param name="isCollectible">
45 <see langword="true" /> to enable <see cref="M:System.Runtime.Loader.AssemblyLoadContext.Unload" />; otherwise, <see langword="false" />. The default value is <see langword="false" /> because there is a performance cost associated with enabling unloading.</param>
47 <member name="P:System.Runtime.Loader.AssemblyLoadContext.All">
48 <summary>Returns a collection of all <see cref="T:System.Runtime.Loader.AssemblyLoadContext" /> instances.</summary>
49 <returns>A collection of all <see cref="T:System.Runtime.Loader.AssemblyLoadContext" /> instances.</returns>
51 <member name="P:System.Runtime.Loader.AssemblyLoadContext.Assemblies">
52 <summary>Returns a collection of the <see cref="T:System.Reflection.Assembly" /> instances loaded in the <see cref="T:System.Runtime.Loader.AssemblyLoadContext" />.</summary>
53 <returns>A collection of the <see cref="T:System.Reflection.Assembly" /> instances loaded in the <see cref="T:System.Runtime.Loader.AssemblyLoadContext" />.</returns>
55 <member name="T:System.Runtime.Loader.AssemblyLoadContext.ContextualReflectionScope">
56 <summary>Provides a return type used exclusively for <see cref="M:System.Runtime.Loader.AssemblyLoadContext.EnterContextualReflection" />. It is intended to be used as an <see cref="T:System.IDisposable" /> in a <see langword="using" /> block.</summary>
58 <member name="M:System.Runtime.Loader.AssemblyLoadContext.ContextualReflectionScope.Dispose">
59 <summary>Sets <see cref="P:System.Runtime.Loader.AssemblyLoadContext.CurrentContextualReflectionContext" /> to the value preceding the call to <see cref="M:System.Runtime.Loader.AssemblyLoadContext.EnterContextualReflection" /> which returned this instance.</summary>
61 <member name="P:System.Runtime.Loader.AssemblyLoadContext.CurrentContextualReflectionContext">
62 <summary>Gets the <see cref="T:System.Runtime.Loader.AssemblyLoadContext" /> set by the most recent call to <see cref="M:System.Runtime.Loader.AssemblyLoadContext.EnterContextualReflection" />.</summary>
63 <returns>The <see cref="T:System.Runtime.Loader.AssemblyLoadContext" /> set by the most recent call to <see cref="M:System.Runtime.Loader.AssemblyLoadContext.EnterContextualReflection" />. This value can be <see langword="null" />. The value is stored in an <see cref="T:System.Threading.AsyncLocal`1" />, so the value is unique per asynchronous context.</returns>
65 <member name="P:System.Runtime.Loader.AssemblyLoadContext.Default">
66 <summary>Gets the default <see cref="T:System.Runtime.Loader.AssemblyLoadContext" />. The default context contains the main application assembly and its static dependencies.</summary>
67 <returns>The default assembly load context.</returns>
69 <member name="M:System.Runtime.Loader.AssemblyLoadContext.EnterContextualReflection">
70 <summary>Sets <see cref="P:System.Runtime.Loader.AssemblyLoadContext.CurrentContextualReflectionContext" /> to <see langword="this" /><see cref="T:System.Runtime.Loader.AssemblyLoadContext" />.</summary>
71 <returns>An object to restore the previous value of <see cref="P:System.Runtime.Loader.AssemblyLoadContext.CurrentContextualReflectionContext" />. It is intended to be used as an <see cref="T:System.IDisposable" /> in a <see langword="using" /> block.</returns>
73 <member name="M:System.Runtime.Loader.AssemblyLoadContext.EnterContextualReflection(System.Reflection.Assembly)">
74 <summary>Sets <see cref="P:System.Runtime.Loader.AssemblyLoadContext.CurrentContextualReflectionContext" /> to the <see cref="T:System.Runtime.Loader.AssemblyLoadContext" /> which loaded the assembly.</summary>
75 <param name="activating">The assembly that is used to determine the requested <see cref="T:System.Runtime.Loader.AssemblyLoadContext" /> instance.</param>
76 <returns>An object to restore the previous value of <see cref="P:System.Runtime.Loader.AssemblyLoadContext.CurrentContextualReflectionContext" />. It is intended to be used as an <see cref="T:System.IDisposable" /> in a <see langword="using" /> block.</returns>
78 <member name="M:System.Runtime.Loader.AssemblyLoadContext.Finalize">
79 <summary>Allows the object to try to free resources and perform other cleanup operations before it's reclaimed by garbage collection.</summary>
81 <member name="M:System.Runtime.Loader.AssemblyLoadContext.GetAssemblyName(System.String)">
82 <summary>Gets an <see cref="T:System.Reflection.AssemblyName" /> for an assembly path.</summary>
83 <param name="assemblyPath">The path to the assembly.</param>
84 <returns>An object that contains the fully parsed assembly name for the assembly at <paramref name="assemblyPath" />.</returns>
85 <exception cref="T:System.ArgumentNullException">
86 <paramref name="assemblyPath" /> is <see langword="null" />.</exception>
87 <exception cref="T:System.IO.FileNotFoundException">The assembly cannot be found.</exception>
88 <exception cref="T:System.BadImageFormatException">The assembly is not a valid assembly.</exception>
90 <member name="M:System.Runtime.Loader.AssemblyLoadContext.GetLoadContext(System.Reflection.Assembly)">
91 <summary>Gets the <see cref="T:System.Runtime.Loader.AssemblyLoadContext" /> containing the specified <see cref="T:System.Reflection.Assembly" />.</summary>
92 <param name="assembly">An assembly.</param>
93 <returns>The assembly load context containing the <paramref name="assembly" />. If the <paramref name="assembly" /> is not provided by the runtime, this method returns null.</returns>
94 <exception cref="T:System.ArgumentNullException">
95 <paramref name="assembly" /> is <see langword="null" />.</exception>
97 <member name="P:System.Runtime.Loader.AssemblyLoadContext.IsCollectible">
98 <summary>Gets a value that indicates whether this <see cref="T:System.Runtime.Loader.AssemblyLoadContext" /> is collectible.</summary>
100 <see langword="true" /> if this <see cref="T:System.Runtime.Loader.AssemblyLoadContext" /> is collectible; otherwise, <see langword="false" />. If a value is not specified in the constructor, the value is <see langword="false" />.</returns>
102 <member name="M:System.Runtime.Loader.AssemblyLoadContext.Load(System.Reflection.AssemblyName)">
103 <summary>When overridden in a derived class, allows an assembly to be resolved and loaded based on its <see cref="T:System.Reflection.AssemblyName" />.</summary>
104 <param name="assemblyName">The object that describes the assembly to be loaded.</param>
105 <returns>The loaded assembly, or <see langword="null" />.</returns>
107 <member name="M:System.Runtime.Loader.AssemblyLoadContext.LoadFromAssemblyName(System.Reflection.AssemblyName)">
108 <summary>Resolves and loads an assembly given its <see cref="T:System.Reflection.AssemblyName" />.</summary>
109 <param name="assemblyName">The object that describes the assembly to load.</param>
110 <returns>The loaded assembly, or throws.</returns>
111 <exception cref="T:System.ArgumentNullException">
112 <paramref name="assemblyName" /> is <see langword="null" />.</exception>
113 <exception cref="T:System.IO.FileNotFoundException">
114 <paramref name="assemblyName" /> is not found.</exception>
115 <exception cref="T:System.BadImageFormatException">
116 <paramref name="assemblyName" /> is not a valid assembly.</exception>
117 <exception cref="T:System.IO.FileLoadException">An assembly or module was loaded which did not match the <paramref name="assemblyName" />.</exception>
119 <member name="M:System.Runtime.Loader.AssemblyLoadContext.LoadFromAssemblyPath(System.String)">
120 <summary>Loads the contents of an assembly file on the specified path.</summary>
121 <param name="assemblyPath">The fully qualified path of the file to load.</param>
122 <returns>The loaded assembly.</returns>
123 <exception cref="T:System.ArgumentException">The <paramref name="assemblyPath" /> argument is not an absolute path.</exception>
124 <exception cref="T:System.ArgumentNullException">The <paramref name="assemblyPath" /> parameter is <see langword="null" />.</exception>
125 <exception cref="T:System.IO.FileLoadException">A file that was found could not be loaded.</exception>
126 <exception cref="T:System.IO.FileNotFoundException">The <paramref name="assemblyPath" /> parameter is an empty string ("") or does not exist.</exception>
127 <exception cref="T:System.BadImageFormatException">
128 <paramref name="assemblyPath" /> is not a valid assembly.</exception>
130 <member name="M:System.Runtime.Loader.AssemblyLoadContext.LoadFromNativeImagePath(System.String,System.String)">
131 <summary>Loads the contents of the native image of a managed assembly file on the specified path.</summary>
132 <param name="nativeImagePath">The fully qualified path of the file to load.</param>
133 <param name="assemblyPath">The fully qualified path of the IL version of the file to load, or <see langword="null" />.</param>
134 <returns>The loaded assembly.</returns>
135 <exception cref="T:System.ArgumentException">The <paramref name="nativeImagePath" /> argument is not an absolute path.</exception>
136 <exception cref="T:System.ArgumentException">The <paramref name="assemblyPath" /> argument is not an absolute path.</exception>
137 <exception cref="T:System.ArgumentNullException">The <paramref name="nativeImagePath" /> parameter is <see langword="null" />.</exception>
138 <exception cref="T:System.IO.FileLoadException">A file that was found could not be loaded.</exception>
139 <exception cref="T:System.IO.FileNotFoundException">The <paramref name="nativeImagePath" /> parameter is an empty string ("") or does not exist.</exception>
140 <exception cref="T:System.BadImageFormatException">
141 <paramref name="assemblyPath" /> is not a valid assembly.</exception>
143 <member name="M:System.Runtime.Loader.AssemblyLoadContext.LoadFromStream(System.IO.Stream)">
144 <summary>Loads the assembly with a common object file format (COFF)-based image containing a managed assembly.</summary>
145 <param name="assembly">A byte array that is a COFF-based image containing a managed assembly.</param>
146 <returns>The loaded assembly.</returns>
147 <exception cref="T:System.ArgumentNullException">
148 <paramref name="assembly" /> is <see langword="null" />.</exception>
149 <exception cref="T:System.BadImageFormatException">
150 <paramref name="assembly" /> is not a valid assembly.</exception>
152 <member name="M:System.Runtime.Loader.AssemblyLoadContext.LoadFromStream(System.IO.Stream,System.IO.Stream)">
153 <summary>Loads the assembly with a common object file format (COFF)-based image containing a managed assembly, optionally including symbols for the assembly.</summary>
154 <param name="assembly">A byte array that is a COFF-based image containing a managed assembly.</param>
155 <param name="assemblySymbols">A byte array that contains the raw bytes representing the symbols for the assembly.</param>
156 <returns>The loaded assembly.</returns>
157 <exception cref="T:System.ArgumentNullException">
158 <paramref name="assembly" /> is <see langword="null" />.</exception>
159 <exception cref="T:System.BadImageFormatException">
160 <paramref name="assembly" /> is not a valid assembly.</exception>
162 <member name="M:System.Runtime.Loader.AssemblyLoadContext.LoadUnmanagedDll(System.String)">
163 <summary>Allows derived class to load an unmanaged library by name.</summary>
164 <param name="unmanagedDllName">Name of the unmanaged library. Typically this is the filename without its path or extensions.</param>
165 <returns>A handle to the loaded library, or <see cref="F:System.IntPtr.Zero" />.</returns>
167 <member name="M:System.Runtime.Loader.AssemblyLoadContext.LoadUnmanagedDllFromPath(System.String)">
168 <summary>Loads an unmanaged library from the specified path.</summary>
169 <param name="unmanagedDllPath">The path to the unmanaged library.</param>
170 <returns>The OS handle for the loaded native library.</returns>
171 <exception cref="T:System.ArgumentNullException">
172 <paramref name="unmanagedDllPath" /> is <see langword="null" />.</exception>
173 <exception cref="T:System.ArgumentException">The <paramref name="unmanagedDllPath" /> argument is empty or not an absolute path.</exception>
174 <exception cref="T:System.DllNotFoundException">The library can't be found.</exception>
175 <exception cref="T:System.BadImageFormatException">The library is not valid.</exception>
177 <member name="P:System.Runtime.Loader.AssemblyLoadContext.Name">
178 <summary>Get the name of the <see cref="T:System.Runtime.Loader.AssemblyLoadContext" />.</summary>
179 <returns>The name of the <see cref="T:System.Runtime.Loader.AssemblyLoadContext" />. Its value can be <see langword="null" />.</returns>
181 <member name="E:System.Runtime.Loader.AssemblyLoadContext.Resolving">
182 <summary>Occurs when the resolution of an assembly fails when attempting to load into this assembly load context.</summary>
184 <member name="E:System.Runtime.Loader.AssemblyLoadContext.ResolvingUnmanagedDll">
185 <summary>Occurs when the resolution of a native library fails.</summary>
187 <member name="M:System.Runtime.Loader.AssemblyLoadContext.SetProfileOptimizationRoot(System.String)">
188 <summary>Sets the root path where the optimization profiles for this load context are stored.</summary>
189 <param name="directoryPath">The full path to the directory where the optimization profiles are stored.</param>
191 <member name="M:System.Runtime.Loader.AssemblyLoadContext.StartProfileOptimization(System.String)">
192 <summary>Starts the profile optimization for the specified profile.</summary>
193 <param name="profile">The name of the optimization profile.</param>
195 <member name="M:System.Runtime.Loader.AssemblyLoadContext.ToString">
196 <summary>Returns the string representation of this load context.</summary>
197 <returns>The string representation of this load context.</returns>
199 <member name="M:System.Runtime.Loader.AssemblyLoadContext.Unload">
200 <summary>Initiates an unload of this <see cref="T:System.Runtime.Loader.AssemblyLoadContext" />.</summary>
201 <exception cref="T:System.InvalidOperationException">Unloading is not allowed.</exception>
203 <member name="E:System.Runtime.Loader.AssemblyLoadContext.Unloading">
204 <summary>Occurs when the <see cref="T:System.Runtime.Loader.AssemblyLoadContext" /> is unloaded.</summary>