Microsoft.Bcl.AsyncInterfaces.xml 30 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>Microsoft.Bcl.AsyncInterfaces</name>
  5. </assembly>
  6. <members>
  7. <member name="T:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1">
  8. <summary>Provides the core logic for implementing a manual-reset <see cref="T:System.Threading.Tasks.Sources.IValueTaskSource"/> or <see cref="T:System.Threading.Tasks.Sources.IValueTaskSource`1"/>.</summary>
  9. <typeparam name="TResult"></typeparam>
  10. </member>
  11. <member name="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1._continuation">
  12. <summary>
  13. The callback to invoke when the operation completes if <see cref="M:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.OnCompleted(System.Action{System.Object},System.Object,System.Int16,System.Threading.Tasks.Sources.ValueTaskSourceOnCompletedFlags)"/> was called before the operation completed,
  14. or <see cref="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCoreShared.s_sentinel"/> if the operation completed before a callback was supplied,
  15. or null if a callback hasn't yet been provided and the operation hasn't yet completed.
  16. </summary>
  17. </member>
  18. <member name="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1._continuationState">
  19. <summary>State to pass to <see cref="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1._continuation"/>.</summary>
  20. </member>
  21. <member name="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1._executionContext">
  22. <summary><see cref="T:System.Threading.ExecutionContext"/> to flow to the callback, or null if no flowing is required.</summary>
  23. </member>
  24. <member name="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1._capturedContext">
  25. <summary>
  26. A "captured" <see cref="T:System.Threading.SynchronizationContext"/> or <see cref="T:System.Threading.Tasks.TaskScheduler"/> with which to invoke the callback,
  27. or null if no special context is required.
  28. </summary>
  29. </member>
  30. <member name="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1._completed">
  31. <summary>Whether the current operation has completed.</summary>
  32. </member>
  33. <member name="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1._result">
  34. <summary>The result with which the operation succeeded, or the default value if it hasn't yet completed or failed.</summary>
  35. </member>
  36. <member name="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1._error">
  37. <summary>The exception with which the operation failed, or null if it hasn't yet completed or completed successfully.</summary>
  38. </member>
  39. <member name="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1._version">
  40. <summary>The current version of this value, used to help prevent misuse.</summary>
  41. </member>
  42. <member name="P:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.RunContinuationsAsynchronously">
  43. <summary>Gets or sets whether to force continuations to run asynchronously.</summary>
  44. <remarks>Continuations may run asynchronously if this is false, but they'll never run synchronously if this is true.</remarks>
  45. </member>
  46. <member name="M:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.Reset">
  47. <summary>Resets to prepare for the next operation.</summary>
  48. </member>
  49. <member name="M:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.SetResult(`0)">
  50. <summary>Completes with a successful result.</summary>
  51. <param name="result">The result.</param>
  52. </member>
  53. <member name="M:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.SetException(System.Exception)">
  54. <summary>Complets with an error.</summary>
  55. <param name="error"></param>
  56. </member>
  57. <member name="P:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.Version">
  58. <summary>Gets the operation version.</summary>
  59. </member>
  60. <member name="M:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.GetStatus(System.Int16)">
  61. <summary>Gets the status of the operation.</summary>
  62. <param name="token">Opaque value that was provided to the <see cref="T:System.Threading.Tasks.ValueTask"/>'s constructor.</param>
  63. </member>
  64. <member name="M:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.GetResult(System.Int16)">
  65. <summary>Gets the result of the operation.</summary>
  66. <param name="token">Opaque value that was provided to the <see cref="T:System.Threading.Tasks.ValueTask"/>'s constructor.</param>
  67. </member>
  68. <member name="M:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.OnCompleted(System.Action{System.Object},System.Object,System.Int16,System.Threading.Tasks.Sources.ValueTaskSourceOnCompletedFlags)">
  69. <summary>Schedules the continuation action for this operation.</summary>
  70. <param name="continuation">The continuation to invoke when the operation has completed.</param>
  71. <param name="state">The state object to pass to <paramref name="continuation"/> when it's invoked.</param>
  72. <param name="token">Opaque value that was provided to the <see cref="T:System.Threading.Tasks.ValueTask"/>'s constructor.</param>
  73. <param name="flags">The flags describing the behavior of the continuation.</param>
  74. </member>
  75. <member name="M:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.ValidateToken(System.Int16)">
  76. <summary>Ensures that the specified token matches the current version.</summary>
  77. <param name="token">The token supplied by <see cref="T:System.Threading.Tasks.ValueTask"/>.</param>
  78. </member>
  79. <member name="M:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.SignalCompletion">
  80. <summary>Signals that the operation has completed. Invoked after the result or error has been set.</summary>
  81. </member>
  82. <member name="M:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.InvokeContinuation">
  83. <summary>
  84. Invokes the continuation with the appropriate captured context / scheduler.
  85. This assumes that if <see cref="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1._executionContext"/> is not null we're already
  86. running within that <see cref="T:System.Threading.ExecutionContext"/>.
  87. </summary>
  88. </member>
  89. <member name="T:System.Threading.Tasks.TaskAsyncEnumerableExtensions">
  90. <summary>Provides a set of static methods for configuring <see cref="T:System.Threading.Tasks.Task"/>-related behaviors on asynchronous enumerables and disposables.</summary>
  91. </member>
  92. <member name="M:System.Threading.Tasks.TaskAsyncEnumerableExtensions.ConfigureAwait(System.IAsyncDisposable,System.Boolean)">
  93. <summary>Configures how awaits on the tasks returned from an async disposable will be performed.</summary>
  94. <param name="source">The source async disposable.</param>
  95. <param name="continueOnCapturedContext">Whether to capture and marshal back to the current context.</param>
  96. <returns>The configured async disposable.</returns>
  97. </member>
  98. <member name="M:System.Threading.Tasks.TaskAsyncEnumerableExtensions.ConfigureAwait``1(System.Collections.Generic.IAsyncEnumerable{``0},System.Boolean)">
  99. <summary>Configures how awaits on the tasks returned from an async iteration will be performed.</summary>
  100. <typeparam name="T">The type of the objects being iterated.</typeparam>
  101. <param name="source">The source enumerable being iterated.</param>
  102. <param name="continueOnCapturedContext">Whether to capture and marshal back to the current context.</param>
  103. <returns>The configured enumerable.</returns>
  104. </member>
  105. <member name="M:System.Threading.Tasks.TaskAsyncEnumerableExtensions.WithCancellation``1(System.Collections.Generic.IAsyncEnumerable{``0},System.Threading.CancellationToken)">
  106. <summary>Sets the <see cref="T:System.Threading.CancellationToken"/> to be passed to <see cref="M:System.Collections.Generic.IAsyncEnumerable`1.GetAsyncEnumerator(System.Threading.CancellationToken)"/> when iterating.</summary>
  107. <typeparam name="T">The type of the objects being iterated.</typeparam>
  108. <param name="source">The source enumerable being iterated.</param>
  109. <param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken"/> to use.</param>
  110. <returns>The configured enumerable.</returns>
  111. </member>
  112. <member name="T:System.Runtime.CompilerServices.AsyncIteratorMethodBuilder">
  113. <summary>Represents a builder for asynchronous iterators.</summary>
  114. </member>
  115. <member name="M:System.Runtime.CompilerServices.AsyncIteratorMethodBuilder.Create">
  116. <summary>Creates an instance of the <see cref="T:System.Runtime.CompilerServices.AsyncIteratorMethodBuilder"/> struct.</summary>
  117. <returns>The initialized instance.</returns>
  118. </member>
  119. <member name="M:System.Runtime.CompilerServices.AsyncIteratorMethodBuilder.MoveNext``1(``0@)">
  120. <summary>Invokes <see cref="M:System.Runtime.CompilerServices.IAsyncStateMachine.MoveNext"/> on the state machine while guarding the <see cref="T:System.Threading.ExecutionContext"/>.</summary>
  121. <typeparam name="TStateMachine">The type of the state machine.</typeparam>
  122. <param name="stateMachine">The state machine instance, passed by reference.</param>
  123. </member>
  124. <member name="M:System.Runtime.CompilerServices.AsyncIteratorMethodBuilder.AwaitOnCompleted``2(``0@,``1@)">
  125. <summary>Schedules the state machine to proceed to the next action when the specified awaiter completes.</summary>
  126. <typeparam name="TAwaiter">The type of the awaiter.</typeparam>
  127. <typeparam name="TStateMachine">The type of the state machine.</typeparam>
  128. <param name="awaiter">The awaiter.</param>
  129. <param name="stateMachine">The state machine.</param>
  130. </member>
  131. <member name="M:System.Runtime.CompilerServices.AsyncIteratorMethodBuilder.AwaitUnsafeOnCompleted``2(``0@,``1@)">
  132. <summary>Schedules the state machine to proceed to the next action when the specified awaiter completes.</summary>
  133. <typeparam name="TAwaiter">The type of the awaiter.</typeparam>
  134. <typeparam name="TStateMachine">The type of the state machine.</typeparam>
  135. <param name="awaiter">The awaiter.</param>
  136. <param name="stateMachine">The state machine.</param>
  137. </member>
  138. <member name="M:System.Runtime.CompilerServices.AsyncIteratorMethodBuilder.Complete">
  139. <summary>Marks iteration as being completed, whether successfully or otherwise.</summary>
  140. </member>
  141. <member name="P:System.Runtime.CompilerServices.AsyncIteratorMethodBuilder.ObjectIdForDebugger">
  142. <summary>Gets an object that may be used to uniquely identify this builder to the debugger.</summary>
  143. </member>
  144. <member name="T:System.Runtime.CompilerServices.AsyncIteratorStateMachineAttribute">
  145. <summary>Indicates whether a method is an asynchronous iterator.</summary>
  146. </member>
  147. <member name="M:System.Runtime.CompilerServices.AsyncIteratorStateMachineAttribute.#ctor(System.Type)">
  148. <summary>Initializes a new instance of the <see cref="T:System.Runtime.CompilerServices.AsyncIteratorStateMachineAttribute"/> class.</summary>
  149. <param name="stateMachineType">The type object for the underlying state machine type that's used to implement a state machine method.</param>
  150. </member>
  151. <member name="T:System.Runtime.CompilerServices.ConfiguredAsyncDisposable">
  152. <summary>Provides a type that can be used to configure how awaits on an <see cref="T:System.IAsyncDisposable"/> are performed.</summary>
  153. </member>
  154. <member name="M:System.Runtime.CompilerServices.ConfiguredAsyncDisposable.DisposeAsync">
  155. <summary>Asynchronously releases the unmanaged resources used by the <see cref="T:System.Runtime.CompilerServices.ConfiguredAsyncDisposable" />.</summary>
  156. <returns>A task that represents the asynchronous dispose operation.</returns>
  157. </member>
  158. <member name="T:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1">
  159. <summary>Provides an awaitable async enumerable that enables cancelable iteration and configured awaits.</summary>
  160. </member>
  161. <member name="M:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1.ConfigureAwait(System.Boolean)">
  162. <summary>Configures how awaits on the tasks returned from an async iteration will be performed.</summary>
  163. <param name="continueOnCapturedContext">Whether to capture and marshal back to the current context.</param>
  164. <returns>The configured enumerable.</returns>
  165. <remarks>This will replace any previous value set by <see cref="M:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1.ConfigureAwait(System.Boolean)"/> for this iteration.</remarks>
  166. </member>
  167. <member name="M:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1.WithCancellation(System.Threading.CancellationToken)">
  168. <summary>Sets the <see cref="T:System.Threading.CancellationToken"/> to be passed to <see cref="M:System.Collections.Generic.IAsyncEnumerable`1.GetAsyncEnumerator(System.Threading.CancellationToken)"/> when iterating.</summary>
  169. <param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken"/> to use.</param>
  170. <returns>The configured enumerable.</returns>
  171. <remarks>This will replace any previous <see cref="T:System.Threading.CancellationToken"/> set by <see cref="M:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1.WithCancellation(System.Threading.CancellationToken)"/> for this iteration.</remarks>
  172. </member>
  173. <member name="M:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1.GetAsyncEnumerator">
  174. <summary>Returns an enumerator that iterates asynchronously through collections that enables cancelable iteration and configured awaits.</summary>
  175. <returns>An enumerator for the <see cref="T:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1" /> class.</returns>
  176. </member>
  177. <member name="T:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1.Enumerator">
  178. <summary>Provides an awaitable async enumerator that enables cancelable iteration and configured awaits.</summary>
  179. </member>
  180. <member name="M:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1.Enumerator.MoveNextAsync">
  181. <summary>Advances the enumerator asynchronously to the next element of the collection.</summary>
  182. <returns>
  183. A <see cref="T:System.Runtime.CompilerServices.ConfiguredValueTaskAwaitable`1"/> that will complete with a result of <c>true</c>
  184. if the enumerator was successfully advanced to the next element, or <c>false</c> if the enumerator has
  185. passed the end of the collection.
  186. </returns>
  187. </member>
  188. <member name="P:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1.Enumerator.Current">
  189. <summary>Gets the element in the collection at the current position of the enumerator.</summary>
  190. </member>
  191. <member name="M:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1.Enumerator.DisposeAsync">
  192. <summary>
  193. Performs application-defined tasks associated with freeing, releasing, or
  194. resetting unmanaged resources asynchronously.
  195. </summary>
  196. </member>
  197. <member name="T:System.Runtime.CompilerServices.EnumeratorCancellationAttribute">
  198. <summary>Allows users of async-enumerable methods to mark the parameter that should receive the cancellation token value from <see cref="M:System.Collections.Generic.IAsyncEnumerable`1.GetAsyncEnumerator(System.Threading.CancellationToken)" />.</summary>
  199. </member>
  200. <member name="M:System.Runtime.CompilerServices.EnumeratorCancellationAttribute.#ctor">
  201. <summary>Initializes a new instance of the <see cref="T:System.Runtime.CompilerServices.EnumeratorCancellationAttribute" /> class.</summary>
  202. </member>
  203. <member name="T:System.Runtime.InteropServices.LibraryImportAttribute">
  204. <summary>
  205. Attribute used to indicate a source generator should create a function for marshalling
  206. arguments instead of relying on the runtime to generate an equivalent marshalling function at run-time.
  207. </summary>
  208. <remarks>
  209. This attribute is meaningless if the source generator associated with it is not enabled.
  210. The current built-in source generator only supports C# and only supplies an implementation when
  211. applied to static, partial, non-generic methods.
  212. </remarks>
  213. </member>
  214. <member name="M:System.Runtime.InteropServices.LibraryImportAttribute.#ctor(System.String)">
  215. <summary>
  216. Initializes a new instance of the <see cref="T:System.Runtime.InteropServices.LibraryImportAttribute"/>.
  217. </summary>
  218. <param name="libraryName">Name of the library containing the import.</param>
  219. </member>
  220. <member name="P:System.Runtime.InteropServices.LibraryImportAttribute.LibraryName">
  221. <summary>
  222. Gets the name of the library containing the import.
  223. </summary>
  224. </member>
  225. <member name="P:System.Runtime.InteropServices.LibraryImportAttribute.EntryPoint">
  226. <summary>
  227. Gets or sets the name of the entry point to be called.
  228. </summary>
  229. </member>
  230. <member name="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshalling">
  231. <summary>
  232. Gets or sets how to marshal string arguments to the method.
  233. </summary>
  234. <remarks>
  235. If this field is set to a value other than <see cref="F:System.Runtime.InteropServices.StringMarshalling.Custom" />,
  236. <see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType" /> must not be specified.
  237. </remarks>
  238. </member>
  239. <member name="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType">
  240. <summary>
  241. Gets or sets the <see cref="T:System.Type"/> used to control how string arguments to the method are marshalled.
  242. </summary>
  243. <remarks>
  244. If this field is specified, <see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshalling" /> must not be specified
  245. or must be set to <see cref="F:System.Runtime.InteropServices.StringMarshalling.Custom" />.
  246. </remarks>
  247. </member>
  248. <member name="P:System.Runtime.InteropServices.LibraryImportAttribute.SetLastError">
  249. <summary>
  250. Gets or sets whether the callee sets an error (SetLastError on Windows or errno
  251. on other platforms) before returning from the attributed method.
  252. </summary>
  253. </member>
  254. <member name="T:System.Runtime.InteropServices.StringMarshalling">
  255. <summary>
  256. Specifies how strings should be marshalled for generated p/invokes
  257. </summary>
  258. </member>
  259. <member name="F:System.Runtime.InteropServices.StringMarshalling.Custom">
  260. <summary>
  261. Indicates the user is suppling a specific marshaller in <see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType"/>.
  262. </summary>
  263. </member>
  264. <member name="F:System.Runtime.InteropServices.StringMarshalling.Utf8">
  265. <summary>
  266. Use the platform-provided UTF-8 marshaller.
  267. </summary>
  268. </member>
  269. <member name="F:System.Runtime.InteropServices.StringMarshalling.Utf16">
  270. <summary>
  271. Use the platform-provided UTF-16 marshaller.
  272. </summary>
  273. </member>
  274. <member name="T:System.Collections.Generic.IAsyncEnumerable`1">
  275. <summary>Exposes an enumerator that provides asynchronous iteration over values of a specified type.</summary>
  276. <typeparam name="T">The type of values to enumerate.</typeparam>
  277. </member>
  278. <member name="M:System.Collections.Generic.IAsyncEnumerable`1.GetAsyncEnumerator(System.Threading.CancellationToken)">
  279. <summary>Returns an enumerator that iterates asynchronously through the collection.</summary>
  280. <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken"/> that may be used to cancel the asynchronous iteration.</param>
  281. <returns>An enumerator that can be used to iterate asynchronously through the collection.</returns>
  282. </member>
  283. <member name="T:System.Collections.Generic.IAsyncEnumerator`1">
  284. <summary>Supports a simple asynchronous iteration over a generic collection.</summary>
  285. <typeparam name="T">The type of objects to enumerate.</typeparam>
  286. </member>
  287. <member name="M:System.Collections.Generic.IAsyncEnumerator`1.MoveNextAsync">
  288. <summary>Advances the enumerator asynchronously to the next element of the collection.</summary>
  289. <returns>
  290. A <see cref="T:System.Threading.Tasks.ValueTask`1"/> that will complete with a result of <c>true</c> if the enumerator
  291. was successfully advanced to the next element, or <c>false</c> if the enumerator has passed the end
  292. of the collection.
  293. </returns>
  294. </member>
  295. <member name="P:System.Collections.Generic.IAsyncEnumerator`1.Current">
  296. <summary>Gets the element in the collection at the current position of the enumerator.</summary>
  297. </member>
  298. <member name="T:System.IAsyncDisposable">
  299. <summary>Provides a mechanism for releasing unmanaged resources asynchronously.</summary>
  300. </member>
  301. <member name="M:System.IAsyncDisposable.DisposeAsync">
  302. <summary>
  303. Performs application-defined tasks associated with freeing, releasing, or
  304. resetting unmanaged resources asynchronously.
  305. </summary>
  306. </member>
  307. <member name="T:System.Diagnostics.CodeAnalysis.AllowNullAttribute">
  308. <summary>Specifies that null is allowed as an input even if the corresponding type disallows it.</summary>
  309. </member>
  310. <member name="T:System.Diagnostics.CodeAnalysis.DisallowNullAttribute">
  311. <summary>Specifies that null is disallowed as an input even if the corresponding type allows it.</summary>
  312. </member>
  313. <member name="T:System.Diagnostics.CodeAnalysis.MaybeNullAttribute">
  314. <summary>Specifies that an output may be null even if the corresponding type disallows it.</summary>
  315. </member>
  316. <member name="T:System.Diagnostics.CodeAnalysis.NotNullAttribute">
  317. <summary>Specifies that an output will not be null even if the corresponding type allows it. Specifies that an input argument was not null when the call returns.</summary>
  318. </member>
  319. <member name="T:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute">
  320. <summary>Specifies that when a method returns <see cref="P:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.ReturnValue"/>, the parameter may be null even if the corresponding type disallows it.</summary>
  321. </member>
  322. <member name="M:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.#ctor(System.Boolean)">
  323. <summary>Initializes the attribute with the specified return value condition.</summary>
  324. <param name="returnValue">
  325. The return value condition. If the method returns this value, the associated parameter may be null.
  326. </param>
  327. </member>
  328. <member name="P:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.ReturnValue">
  329. <summary>Gets the return value condition.</summary>
  330. </member>
  331. <member name="T:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute">
  332. <summary>Specifies that when a method returns <see cref="P:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.ReturnValue"/>, the parameter will not be null even if the corresponding type allows it.</summary>
  333. </member>
  334. <member name="M:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.#ctor(System.Boolean)">
  335. <summary>Initializes the attribute with the specified return value condition.</summary>
  336. <param name="returnValue">
  337. The return value condition. If the method returns this value, the associated parameter will not be null.
  338. </param>
  339. </member>
  340. <member name="P:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.ReturnValue">
  341. <summary>Gets the return value condition.</summary>
  342. </member>
  343. <member name="T:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute">
  344. <summary>Specifies that the output will be non-null if the named parameter is non-null.</summary>
  345. </member>
  346. <member name="M:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute.#ctor(System.String)">
  347. <summary>Initializes the attribute with the associated parameter name.</summary>
  348. <param name="parameterName">
  349. The associated parameter name. The output will be non-null if the argument to the parameter specified is non-null.
  350. </param>
  351. </member>
  352. <member name="P:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute.ParameterName">
  353. <summary>Gets the associated parameter name.</summary>
  354. </member>
  355. <member name="T:System.Diagnostics.CodeAnalysis.DoesNotReturnAttribute">
  356. <summary>Applied to a method that will never return under any circumstance.</summary>
  357. </member>
  358. <member name="T:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute">
  359. <summary>Specifies that the method will not return if the associated Boolean parameter is passed the specified value.</summary>
  360. </member>
  361. <member name="M:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute.#ctor(System.Boolean)">
  362. <summary>Initializes the attribute with the specified parameter value.</summary>
  363. <param name="parameterValue">
  364. The condition parameter value. Code after the method will be considered unreachable by diagnostics if the argument to
  365. the associated parameter matches this value.
  366. </param>
  367. </member>
  368. <member name="P:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute.ParameterValue">
  369. <summary>Gets the condition parameter value.</summary>
  370. </member>
  371. <member name="T:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute">
  372. <summary>Specifies that the method or property will ensure that the listed field and property members have not-null values.</summary>
  373. </member>
  374. <member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.#ctor(System.String)">
  375. <summary>Initializes the attribute with a field or property member.</summary>
  376. <param name="member">
  377. The field or property member that is promised to be not-null.
  378. </param>
  379. </member>
  380. <member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.#ctor(System.String[])">
  381. <summary>Initializes the attribute with the list of field and property members.</summary>
  382. <param name="members">
  383. The list of field and property members that are promised to be not-null.
  384. </param>
  385. </member>
  386. <member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.Members">
  387. <summary>Gets field or property member names.</summary>
  388. </member>
  389. <member name="T:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute">
  390. <summary>Specifies that the method or property will ensure that the listed field and property members have not-null values when returning with the specified return value condition.</summary>
  391. </member>
  392. <member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.#ctor(System.Boolean,System.String)">
  393. <summary>Initializes the attribute with the specified return value condition and a field or property member.</summary>
  394. <param name="returnValue">
  395. The return value condition. If the method returns this value, the associated parameter will not be null.
  396. </param>
  397. <param name="member">
  398. The field or property member that is promised to be not-null.
  399. </param>
  400. </member>
  401. <member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.#ctor(System.Boolean,System.String[])">
  402. <summary>Initializes the attribute with the specified return value condition and list of field and property members.</summary>
  403. <param name="returnValue">
  404. The return value condition. If the method returns this value, the associated parameter will not be null.
  405. </param>
  406. <param name="members">
  407. The list of field and property members that are promised to be not-null.
  408. </param>
  409. </member>
  410. <member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.ReturnValue">
  411. <summary>Gets the return value condition.</summary>
  412. </member>
  413. <member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.Members">
  414. <summary>Gets field or property member names.</summary>
  415. </member>
  416. </members>
  417. </doc>