Microsoft.Extensions.FileProviders.Physical.xml 45 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>Microsoft.Extensions.FileProviders.Physical</name>
  5. </assembly>
  6. <members>
  7. <member name="T:Microsoft.Extensions.FileProviders.Physical.ExclusionFilters">
  8. <summary>
  9. Specifies filtering behavior for files or directories.
  10. </summary>
  11. </member>
  12. <member name="F:Microsoft.Extensions.FileProviders.Physical.ExclusionFilters.Sensitive">
  13. <summary>
  14. Equivalent to <c>DotPrefixed | Hidden | System</c>. Exclude files and directories when the name begins with a period, or has either <see cref="F:System.IO.FileAttributes.Hidden"/> or <see cref="F:System.IO.FileAttributes.System"/> is set on <see cref="P:System.IO.FileSystemInfo.Attributes"/>.
  15. </summary>
  16. </member>
  17. <member name="F:Microsoft.Extensions.FileProviders.Physical.ExclusionFilters.DotPrefixed">
  18. <summary>
  19. Exclude files and directories when the name begins with period.
  20. </summary>
  21. </member>
  22. <member name="F:Microsoft.Extensions.FileProviders.Physical.ExclusionFilters.Hidden">
  23. <summary>
  24. Exclude files and directories when <see cref="F:System.IO.FileAttributes.Hidden"/> is set on <see cref="P:System.IO.FileSystemInfo.Attributes"/>.
  25. </summary>
  26. </member>
  27. <member name="F:Microsoft.Extensions.FileProviders.Physical.ExclusionFilters.System">
  28. <summary>
  29. Exclude files and directories when <see cref="F:System.IO.FileAttributes.System"/> is set on <see cref="P:System.IO.FileSystemInfo.Attributes"/>.
  30. </summary>
  31. </member>
  32. <member name="F:Microsoft.Extensions.FileProviders.Physical.ExclusionFilters.None">
  33. <summary>
  34. Do not exclude any files.
  35. </summary>
  36. </member>
  37. <member name="T:Microsoft.Extensions.FileProviders.Physical.PhysicalDirectoryInfo">
  38. <summary>
  39. Represents a directory on a physical filesystem
  40. </summary>
  41. </member>
  42. <member name="M:Microsoft.Extensions.FileProviders.Physical.PhysicalDirectoryInfo.#ctor(System.IO.DirectoryInfo)">
  43. <summary>
  44. Initializes an instance of <see cref="T:Microsoft.Extensions.FileProviders.Physical.PhysicalDirectoryInfo"/> that wraps an instance of <see cref="T:System.IO.DirectoryInfo"/>
  45. </summary>
  46. <param name="info">The directory</param>
  47. </member>
  48. <member name="P:Microsoft.Extensions.FileProviders.Physical.PhysicalDirectoryInfo.Exists">
  49. <inheritdoc />
  50. </member>
  51. <member name="P:Microsoft.Extensions.FileProviders.Physical.PhysicalDirectoryInfo.Length">
  52. <summary>
  53. Always equals -1.
  54. </summary>
  55. </member>
  56. <member name="P:Microsoft.Extensions.FileProviders.Physical.PhysicalDirectoryInfo.PhysicalPath">
  57. <inheritdoc />
  58. </member>
  59. <member name="P:Microsoft.Extensions.FileProviders.Physical.PhysicalDirectoryInfo.Name">
  60. <inheritdoc />
  61. </member>
  62. <member name="P:Microsoft.Extensions.FileProviders.Physical.PhysicalDirectoryInfo.LastModified">
  63. <summary>
  64. The time when the directory was last written to.
  65. </summary>
  66. </member>
  67. <member name="P:Microsoft.Extensions.FileProviders.Physical.PhysicalDirectoryInfo.IsDirectory">
  68. <summary>
  69. Always true.
  70. </summary>
  71. </member>
  72. <member name="M:Microsoft.Extensions.FileProviders.Physical.PhysicalDirectoryInfo.CreateReadStream">
  73. <summary>
  74. Always throws an exception because read streams are not support on directories.
  75. </summary>
  76. <exception cref="T:System.InvalidOperationException">Always thrown</exception>
  77. <returns>Never returns</returns>
  78. </member>
  79. <member name="T:Microsoft.Extensions.FileProviders.Physical.PhysicalFileInfo">
  80. <summary>
  81. Represents a file on a physical filesystem
  82. </summary>
  83. </member>
  84. <member name="M:Microsoft.Extensions.FileProviders.Physical.PhysicalFileInfo.#ctor(System.IO.FileInfo)">
  85. <summary>
  86. Initializes an instance of <see cref="T:Microsoft.Extensions.FileProviders.Physical.PhysicalFileInfo"/> that wraps an instance of <see cref="T:System.IO.FileInfo"/>
  87. </summary>
  88. <param name="info">The <see cref="T:System.IO.FileInfo"/></param>
  89. </member>
  90. <member name="P:Microsoft.Extensions.FileProviders.Physical.PhysicalFileInfo.Exists">
  91. <inheritdoc />
  92. </member>
  93. <member name="P:Microsoft.Extensions.FileProviders.Physical.PhysicalFileInfo.Length">
  94. <inheritdoc />
  95. </member>
  96. <member name="P:Microsoft.Extensions.FileProviders.Physical.PhysicalFileInfo.PhysicalPath">
  97. <inheritdoc />
  98. </member>
  99. <member name="P:Microsoft.Extensions.FileProviders.Physical.PhysicalFileInfo.Name">
  100. <inheritdoc />
  101. </member>
  102. <member name="P:Microsoft.Extensions.FileProviders.Physical.PhysicalFileInfo.LastModified">
  103. <inheritdoc />
  104. </member>
  105. <member name="P:Microsoft.Extensions.FileProviders.Physical.PhysicalFileInfo.IsDirectory">
  106. <summary>
  107. Always false.
  108. </summary>
  109. </member>
  110. <member name="M:Microsoft.Extensions.FileProviders.Physical.PhysicalFileInfo.CreateReadStream">
  111. <inheritdoc />
  112. </member>
  113. <member name="T:Microsoft.Extensions.FileProviders.Physical.PhysicalFilesWatcher">
  114. <summary>
  115. <para>
  116. A file watcher that watches a physical filesystem for changes.
  117. </para>
  118. <para>
  119. Triggers events on <see cref="T:Microsoft.Extensions.Primitives.IChangeToken" /> when files are created, change, renamed, or deleted.
  120. </para>
  121. </summary>
  122. </member>
  123. <member name="M:Microsoft.Extensions.FileProviders.Physical.PhysicalFilesWatcher.#ctor(System.String,System.IO.FileSystemWatcher,System.Boolean)">
  124. <summary>
  125. Initializes an instance of <see cref="T:Microsoft.Extensions.FileProviders.Physical.PhysicalFilesWatcher" /> that watches files in <paramref name="root" />.
  126. Wraps an instance of <see cref="T:System.IO.FileSystemWatcher" />
  127. </summary>
  128. <param name="root">Root directory for the watcher</param>
  129. <param name="fileSystemWatcher">The wrapped watcher that is watching <paramref name="root" /></param>
  130. <param name="pollForChanges">
  131. True when the watcher should use polling to trigger instances of
  132. <see cref="T:Microsoft.Extensions.Primitives.IChangeToken" /> created by <see cref="M:Microsoft.Extensions.FileProviders.Physical.PhysicalFilesWatcher.CreateFileChangeToken(System.String)" />
  133. </param>
  134. </member>
  135. <member name="M:Microsoft.Extensions.FileProviders.Physical.PhysicalFilesWatcher.#ctor(System.String,System.IO.FileSystemWatcher,System.Boolean,Microsoft.Extensions.FileProviders.Physical.ExclusionFilters)">
  136. <summary>
  137. Initializes an instance of <see cref="T:Microsoft.Extensions.FileProviders.Physical.PhysicalFilesWatcher" /> that watches files in <paramref name="root" />.
  138. Wraps an instance of <see cref="T:System.IO.FileSystemWatcher" />
  139. </summary>
  140. <param name="root">Root directory for the watcher</param>
  141. <param name="fileSystemWatcher">The wrapped watcher that is watching <paramref name="root" /></param>
  142. <param name="pollForChanges">
  143. True when the watcher should use polling to trigger instances of
  144. <see cref="T:Microsoft.Extensions.Primitives.IChangeToken" /> created by <see cref="M:Microsoft.Extensions.FileProviders.Physical.PhysicalFilesWatcher.CreateFileChangeToken(System.String)" />
  145. </param>
  146. <param name="filters">Specifies which files or directories are excluded. Notifications of changes to are not raised to these.</param>
  147. </member>
  148. <member name="M:Microsoft.Extensions.FileProviders.Physical.PhysicalFilesWatcher.CreateFileChangeToken(System.String)">
  149. <summary>
  150. <para>
  151. Creates an instance of <see cref="T:Microsoft.Extensions.Primitives.IChangeToken" /> for all files and directories that match the
  152. <paramref name="filter" />
  153. </para>
  154. <para>
  155. Globbing patterns are relative to the root directory given in the constructor
  156. <seealso cref="M:Microsoft.Extensions.FileProviders.Physical.PhysicalFilesWatcher.#ctor(System.String,System.IO.FileSystemWatcher,System.Boolean)" />. Globbing patterns
  157. are interpreted by <seealso cref="T:Microsoft.Extensions.FileSystemGlobbing.Matcher" />.
  158. </para>
  159. </summary>
  160. <param name="filter">A globbing pattern for files and directories to watch</param>
  161. <returns>A change token for all files that match the filter</returns>
  162. <exception cref="T:System.ArgumentNullException">When <paramref name="filter" /> is null</exception>
  163. </member>
  164. <member name="M:Microsoft.Extensions.FileProviders.Physical.PhysicalFilesWatcher.Dispose">
  165. <summary>
  166. Disposes the provider. Change tokens may not trigger after the provider is disposed.
  167. </summary>
  168. </member>
  169. <member name="M:Microsoft.Extensions.FileProviders.Physical.PhysicalFilesWatcher.Dispose(System.Boolean)">
  170. <summary>
  171. Disposes the provider.
  172. </summary>
  173. <param name="disposing"><c>true</c> is invoked from <see cref="M:System.IDisposable.Dispose"/>.</param>
  174. </member>
  175. <member name="T:Microsoft.Extensions.FileProviders.Physical.PollingFileChangeToken">
  176. <summary>
  177. <para>
  178. A change token that polls for file system changes.
  179. </para>
  180. <para>
  181. This change token does not raise any change callbacks. Callers should watch for <see cref="P:Microsoft.Extensions.FileProviders.Physical.PollingFileChangeToken.HasChanged" /> to turn
  182. from false to true
  183. and dispose the token after this happens.
  184. </para>
  185. </summary>
  186. <remarks>
  187. Polling occurs every 4 seconds.
  188. </remarks>
  189. </member>
  190. <member name="M:Microsoft.Extensions.FileProviders.Physical.PollingFileChangeToken.#ctor(System.IO.FileInfo)">
  191. <summary>
  192. Initializes a new instance of <see cref="T:Microsoft.Extensions.FileProviders.Physical.PollingFileChangeToken" /> that polls the specified file for changes as
  193. determined by <see cref="P:System.IO.FileSystemInfo.LastWriteTimeUtc" />.
  194. </summary>
  195. <param name="fileInfo">The <see cref="T:System.IO.FileInfo"/> to poll</param>
  196. </member>
  197. <member name="P:Microsoft.Extensions.FileProviders.Physical.PollingFileChangeToken.ActiveChangeCallbacks">
  198. <summary>
  199. Always false.
  200. </summary>
  201. </member>
  202. <member name="P:Microsoft.Extensions.FileProviders.Physical.PollingFileChangeToken.HasChanged">
  203. <summary>
  204. True when the file has changed since the change token was created. Once the file changes, this value is always true
  205. </summary>
  206. <remarks>
  207. Once true, the value will always be true. Change tokens should not re-used once expired. The caller should discard this
  208. instance once it sees <see cref="P:Microsoft.Extensions.FileProviders.Physical.PollingFileChangeToken.HasChanged" /> is true.
  209. </remarks>
  210. </member>
  211. <member name="M:Microsoft.Extensions.FileProviders.Physical.PollingFileChangeToken.RegisterChangeCallback(System.Action{System.Object},System.Object)">
  212. <summary>
  213. Does not actually register callbacks.
  214. </summary>
  215. <param name="callback">This parameter is ignored</param>
  216. <param name="state">This parameter is ignored</param>
  217. <returns>A disposable object that noops when disposed</returns>
  218. </member>
  219. <member name="T:Microsoft.Extensions.FileProviders.Physical.PollingWildCardChangeToken">
  220. <summary>
  221. A polling based <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/> for wildcard patterns.
  222. </summary>
  223. </member>
  224. <member name="M:Microsoft.Extensions.FileProviders.Physical.PollingWildCardChangeToken.#ctor(System.String,System.String)">
  225. <summary>
  226. Initializes a new instance of <see cref="T:Microsoft.Extensions.FileProviders.Physical.PollingWildCardChangeToken"/>.
  227. </summary>
  228. <param name="root">The root of the file system.</param>
  229. <param name="pattern">The pattern to watch.</param>
  230. </member>
  231. <member name="P:Microsoft.Extensions.FileProviders.Physical.PollingWildCardChangeToken.ActiveChangeCallbacks">
  232. <inheritdoc />
  233. </member>
  234. <member name="P:Microsoft.Extensions.FileProviders.Physical.PollingWildCardChangeToken.HasChanged">
  235. <inheritdoc />
  236. </member>
  237. <member name="M:Microsoft.Extensions.FileProviders.Physical.PollingWildCardChangeToken.GetLastWriteUtc(System.String)">
  238. <summary>
  239. Gets the last write time of the file at the specified <paramref name="path"/>.
  240. </summary>
  241. <param name="path">The root relative path.</param>
  242. <returns>The <see cref="T:System.DateTime"/> that the file was last modified.</returns>
  243. </member>
  244. <member name="T:Microsoft.Extensions.FileProviders.Internal.PhysicalDirectoryContents">
  245. <summary>
  246. Represents the contents of a physical file directory
  247. </summary>
  248. </member>
  249. <member name="M:Microsoft.Extensions.FileProviders.Internal.PhysicalDirectoryContents.#ctor(System.String)">
  250. <summary>
  251. Initializes an instance of <see cref="T:Microsoft.Extensions.FileProviders.Internal.PhysicalDirectoryContents"/>
  252. </summary>
  253. <param name="directory">The directory</param>
  254. </member>
  255. <member name="M:Microsoft.Extensions.FileProviders.Internal.PhysicalDirectoryContents.#ctor(System.String,Microsoft.Extensions.FileProviders.Physical.ExclusionFilters)">
  256. <summary>
  257. Initializes an instance of <see cref="T:Microsoft.Extensions.FileProviders.Internal.PhysicalDirectoryContents"/>
  258. </summary>
  259. <param name="directory">The directory</param>
  260. <param name="filters">Specifies which files or directories are excluded from enumeration.</param>
  261. </member>
  262. <member name="P:Microsoft.Extensions.FileProviders.Internal.PhysicalDirectoryContents.Exists">
  263. <inheritdoc />
  264. </member>
  265. <member name="M:Microsoft.Extensions.FileProviders.Internal.PhysicalDirectoryContents.GetEnumerator">
  266. <inheritdoc />
  267. </member>
  268. <member name="T:Microsoft.Extensions.FileProviders.PhysicalFileProvider">
  269. <summary>
  270. Looks up files using the on-disk file system
  271. </summary>
  272. <remarks>
  273. When the environment variable "DOTNET_USE_POLLING_FILE_WATCHER" is set to "1" or "true", calls to
  274. <see cref="M:Microsoft.Extensions.FileProviders.PhysicalFileProvider.Watch(System.String)" /> will use <see cref="T:Microsoft.Extensions.FileProviders.Physical.PollingFileChangeToken" />.
  275. </remarks>
  276. </member>
  277. <member name="M:Microsoft.Extensions.FileProviders.PhysicalFileProvider.#ctor(System.String)">
  278. <summary>
  279. Initializes a new instance of a PhysicalFileProvider at the given root directory.
  280. </summary>
  281. <param name="root">The root directory. This should be an absolute path.</param>
  282. </member>
  283. <member name="M:Microsoft.Extensions.FileProviders.PhysicalFileProvider.#ctor(System.String,Microsoft.Extensions.FileProviders.Physical.ExclusionFilters)">
  284. <summary>
  285. Initializes a new instance of a PhysicalFileProvider at the given root directory.
  286. </summary>
  287. <param name="root">The root directory. This should be an absolute path.</param>
  288. <param name="filters">Specifies which files or directories are excluded.</param>
  289. </member>
  290. <member name="P:Microsoft.Extensions.FileProviders.PhysicalFileProvider.UsePollingFileWatcher">
  291. <summary>
  292. Gets or sets a value that determines if this instance of <see cref="T:Microsoft.Extensions.FileProviders.PhysicalFileProvider"/>
  293. uses polling to determine file changes.
  294. <para>
  295. By default, <see cref="T:Microsoft.Extensions.FileProviders.PhysicalFileProvider"/> uses <see cref="T:System.IO.FileSystemWatcher"/> to listen to file change events
  296. for <see cref="M:Microsoft.Extensions.FileProviders.PhysicalFileProvider.Watch(System.String)"/>. <see cref="T:System.IO.FileSystemWatcher"/> is ineffective in some scenarios such as mounted drives.
  297. Polling is required to effectively watch for file changes.
  298. </para>
  299. <seealso cref="P:Microsoft.Extensions.FileProviders.PhysicalFileProvider.UseActivePolling"/>.
  300. </summary>
  301. <value>
  302. The default value of this property is determined by the value of environment variable named <c>DOTNET_USE_POLLING_FILE_WATCHER</c>.
  303. When <c>true</c> or <c>1</c>, this property defaults to <c>true</c>; otherwise false.
  304. </value>
  305. </member>
  306. <member name="P:Microsoft.Extensions.FileProviders.PhysicalFileProvider.UseActivePolling">
  307. <summary>
  308. Gets or sets a value that determines if this instance of <see cref="T:Microsoft.Extensions.FileProviders.PhysicalFileProvider"/>
  309. actively polls for file changes.
  310. <para>
  311. When <see langword="true"/>, <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/> returned by <see cref="M:Microsoft.Extensions.FileProviders.PhysicalFileProvider.Watch(System.String)"/> will actively poll for file changes
  312. (<see cref="P:Microsoft.Extensions.Primitives.IChangeToken.ActiveChangeCallbacks"/> will be <see langword="true"/>) instead of being passive.
  313. </para>
  314. <para>
  315. This property is only effective when <see cref="P:Microsoft.Extensions.FileProviders.PhysicalFileProvider.UsePollingFileWatcher"/> is set.
  316. </para>
  317. </summary>
  318. <value>
  319. The default value of this property is determined by the value of environment variable named <c>DOTNET_USE_POLLING_FILE_WATCHER</c>.
  320. When <c>true</c> or <c>1</c>, this property defaults to <c>true</c>; otherwise false.
  321. </value>
  322. </member>
  323. <member name="M:Microsoft.Extensions.FileProviders.PhysicalFileProvider.Dispose">
  324. <summary>
  325. Disposes the provider. Change tokens may not trigger after the provider is disposed.
  326. </summary>
  327. </member>
  328. <member name="M:Microsoft.Extensions.FileProviders.PhysicalFileProvider.Dispose(System.Boolean)">
  329. <summary>
  330. Disposes the provider.
  331. </summary>
  332. <param name="disposing"><c>true</c> is invoked from <see cref="M:System.IDisposable.Dispose"/>.</param>
  333. </member>
  334. <member name="P:Microsoft.Extensions.FileProviders.PhysicalFileProvider.Root">
  335. <summary>
  336. The root directory for this instance.
  337. </summary>
  338. </member>
  339. <member name="M:Microsoft.Extensions.FileProviders.PhysicalFileProvider.GetFileInfo(System.String)">
  340. <summary>
  341. Locate a file at the given path by directly mapping path segments to physical directories.
  342. </summary>
  343. <param name="subpath">A path under the root directory</param>
  344. <returns>The file information. Caller must check <see cref="P:Microsoft.Extensions.FileProviders.IFileInfo.Exists"/> property. </returns>
  345. </member>
  346. <member name="M:Microsoft.Extensions.FileProviders.PhysicalFileProvider.GetDirectoryContents(System.String)">
  347. <summary>
  348. Enumerate a directory at the given path, if any.
  349. </summary>
  350. <param name="subpath">A path under the root directory. Leading slashes are ignored.</param>
  351. <returns>
  352. Contents of the directory. Caller must check <see cref="P:Microsoft.Extensions.FileProviders.IDirectoryContents.Exists"/> property. <see cref="T:Microsoft.Extensions.FileProviders.NotFoundDirectoryContents" /> if
  353. <paramref name="subpath" /> is absolute, if the directory does not exist, or <paramref name="subpath" /> has invalid
  354. characters.
  355. </returns>
  356. </member>
  357. <member name="M:Microsoft.Extensions.FileProviders.PhysicalFileProvider.Watch(System.String)">
  358. <summary>
  359. <para>Creates a <see cref="T:Microsoft.Extensions.Primitives.IChangeToken" /> for the specified <paramref name="filter" />.</para>
  360. <para>Globbing patterns are interpreted by <seealso cref="T:Microsoft.Extensions.FileSystemGlobbing.Matcher" />.</para>
  361. </summary>
  362. <param name="filter">
  363. Filter string used to determine what files or folders to monitor. Example: **/*.cs, *.*,
  364. subFolder/**/*.cshtml.
  365. </param>
  366. <returns>
  367. An <see cref="T:Microsoft.Extensions.Primitives.IChangeToken" /> that is notified when a file matching <paramref name="filter" /> is added,
  368. modified or deleted. Returns a <see cref="T:Microsoft.Extensions.FileProviders.NullChangeToken" /> if <paramref name="filter" /> has invalid filter
  369. characters or if <paramref name="filter" /> is an absolute path or outside the root directory specified in the
  370. constructor <seealso cref="M:Microsoft.Extensions.FileProviders.PhysicalFileProvider.#ctor(System.String)" />.
  371. </returns>
  372. </member>
  373. <member name="M:System.ThrowHelper.ThrowIfNull(System.Object,System.String)">
  374. <summary>Throws an <see cref="T:System.ArgumentNullException"/> if <paramref name="argument"/> is null.</summary>
  375. <param name="argument">The reference type argument to validate as non-null.</param>
  376. <param name="paramName">The name of the parameter with which <paramref name="argument"/> corresponds.</param>
  377. </member>
  378. <member name="M:System.ThrowHelper.IfNullOrWhitespace(System.String,System.String)">
  379. <summary>
  380. Throws either an <see cref="T:System.ArgumentNullException"/> or an <see cref="T:System.ArgumentException"/>
  381. if the specified string is <see langword="null"/> or whitespace respectively.
  382. </summary>
  383. <param name="argument">String to be checked for <see langword="null"/> or whitespace.</param>
  384. <param name="paramName">The name of the parameter being checked.</param>
  385. <returns>The original value of <paramref name="argument"/>.</returns>
  386. </member>
  387. <member name="T:System.Runtime.InteropServices.LibraryImportAttribute">
  388. <summary>
  389. Attribute used to indicate a source generator should create a function for marshalling
  390. arguments instead of relying on the runtime to generate an equivalent marshalling function at run-time.
  391. </summary>
  392. <remarks>
  393. This attribute is meaningless if the source generator associated with it is not enabled.
  394. The current built-in source generator only supports C# and only supplies an implementation when
  395. applied to static, partial, non-generic methods.
  396. </remarks>
  397. </member>
  398. <member name="M:System.Runtime.InteropServices.LibraryImportAttribute.#ctor(System.String)">
  399. <summary>
  400. Initializes a new instance of the <see cref="T:System.Runtime.InteropServices.LibraryImportAttribute"/>.
  401. </summary>
  402. <param name="libraryName">Name of the library containing the import.</param>
  403. </member>
  404. <member name="P:System.Runtime.InteropServices.LibraryImportAttribute.LibraryName">
  405. <summary>
  406. Gets the name of the library containing the import.
  407. </summary>
  408. </member>
  409. <member name="P:System.Runtime.InteropServices.LibraryImportAttribute.EntryPoint">
  410. <summary>
  411. Gets or sets the name of the entry point to be called.
  412. </summary>
  413. </member>
  414. <member name="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshalling">
  415. <summary>
  416. Gets or sets how to marshal string arguments to the method.
  417. </summary>
  418. <remarks>
  419. If this field is set to a value other than <see cref="F:System.Runtime.InteropServices.StringMarshalling.Custom" />,
  420. <see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType" /> must not be specified.
  421. </remarks>
  422. </member>
  423. <member name="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType">
  424. <summary>
  425. Gets or sets the <see cref="T:System.Type"/> used to control how string arguments to the method are marshalled.
  426. </summary>
  427. <remarks>
  428. If this field is specified, <see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshalling" /> must not be specified
  429. or must be set to <see cref="F:System.Runtime.InteropServices.StringMarshalling.Custom" />.
  430. </remarks>
  431. </member>
  432. <member name="P:System.Runtime.InteropServices.LibraryImportAttribute.SetLastError">
  433. <summary>
  434. Gets or sets whether the callee sets an error (SetLastError on Windows or errno
  435. on other platforms) before returning from the attributed method.
  436. </summary>
  437. </member>
  438. <member name="T:System.Runtime.InteropServices.StringMarshalling">
  439. <summary>
  440. Specifies how strings should be marshalled for generated p/invokes
  441. </summary>
  442. </member>
  443. <member name="F:System.Runtime.InteropServices.StringMarshalling.Custom">
  444. <summary>
  445. Indicates the user is suppling a specific marshaller in <see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType"/>.
  446. </summary>
  447. </member>
  448. <member name="F:System.Runtime.InteropServices.StringMarshalling.Utf8">
  449. <summary>
  450. Use the platform-provided UTF-8 marshaller.
  451. </summary>
  452. </member>
  453. <member name="F:System.Runtime.InteropServices.StringMarshalling.Utf16">
  454. <summary>
  455. Use the platform-provided UTF-16 marshaller.
  456. </summary>
  457. </member>
  458. <member name="T:System.Runtime.Versioning.OSPlatformAttribute">
  459. <summary>
  460. Base type for all platform-specific API attributes.
  461. </summary>
  462. </member>
  463. <member name="T:System.Runtime.Versioning.TargetPlatformAttribute">
  464. <summary>
  465. Records the platform that the project targeted.
  466. </summary>
  467. </member>
  468. <member name="T:System.Runtime.Versioning.SupportedOSPlatformAttribute">
  469. <summary>
  470. Records the operating system (and minimum version) that supports an API. Multiple attributes can be
  471. applied to indicate support on multiple operating systems.
  472. </summary>
  473. <remarks>
  474. Callers can apply a <see cref="T:System.Runtime.Versioning.SupportedOSPlatformAttribute" />
  475. or use guards to prevent calls to APIs on unsupported operating systems.
  476. A given platform should only be specified once.
  477. </remarks>
  478. </member>
  479. <member name="T:System.Runtime.Versioning.UnsupportedOSPlatformAttribute">
  480. <summary>
  481. Marks APIs that were removed in a given operating system version.
  482. </summary>
  483. <remarks>
  484. Primarily used by OS bindings to indicate APIs that are only available in
  485. earlier versions.
  486. </remarks>
  487. </member>
  488. <member name="T:System.Runtime.Versioning.ObsoletedOSPlatformAttribute">
  489. <summary>
  490. Marks APIs that were obsoleted in a given operating system version.
  491. </summary>
  492. <remarks>
  493. Primarily used by OS bindings to indicate APIs that should not be used anymore.
  494. </remarks>
  495. </member>
  496. <member name="T:System.Runtime.Versioning.SupportedOSPlatformGuardAttribute">
  497. <summary>
  498. Annotates a custom guard field, property or method with a supported platform name and optional version.
  499. Multiple attributes can be applied to indicate guard for multiple supported platforms.
  500. </summary>
  501. <remarks>
  502. Callers can apply a <see cref="T:System.Runtime.Versioning.SupportedOSPlatformGuardAttribute" /> to a field, property or method
  503. and use that field, property or method in a conditional or assert statements in order to safely call platform specific APIs.
  504. The type of the field or property should be boolean, the method return type should be boolean in order to be used as platform guard.
  505. </remarks>
  506. </member>
  507. <member name="T:System.Runtime.Versioning.UnsupportedOSPlatformGuardAttribute">
  508. <summary>
  509. Annotates the custom guard field, property or method with an unsupported platform name and optional version.
  510. Multiple attributes can be applied to indicate guard for multiple unsupported platforms.
  511. </summary>
  512. <remarks>
  513. Callers can apply a <see cref="T:System.Runtime.Versioning.UnsupportedOSPlatformGuardAttribute" /> to a field, property or method
  514. and use that field, property or method in a conditional or assert statements as a guard to safely call APIs unsupported on those platforms.
  515. The type of the field or property should be boolean, the method return type should be boolean in order to be used as platform guard.
  516. </remarks>
  517. </member>
  518. <member name="T:System.Security.Cryptography.IncrementalHash">
  519. <summary>
  520. Provides support for computing a hash or HMAC value incrementally across several segments.
  521. </summary>
  522. </member>
  523. <member name="P:System.Security.Cryptography.IncrementalHash.AlgorithmName">
  524. <summary>
  525. Get the name of the algorithm being performed.
  526. </summary>
  527. </member>
  528. <member name="M:System.Security.Cryptography.IncrementalHash.AppendData(System.Byte[])">
  529. <summary>
  530. Append the entire contents of <paramref name="data"/> to the data already processed in the hash or HMAC.
  531. </summary>
  532. <param name="data">The data to process.</param>
  533. <exception cref="T:System.ArgumentNullException"><paramref name="data"/> is <c>null</c>.</exception>
  534. <exception cref="T:System.ObjectDisposedException">The object has already been disposed.</exception>
  535. </member>
  536. <member name="M:System.Security.Cryptography.IncrementalHash.AppendData(System.Byte[],System.Int32,System.Int32)">
  537. <summary>
  538. Append <paramref name="count"/> bytes of <paramref name="data"/>, starting at <paramref name="offset"/>,
  539. to the data already processed in the hash or HMAC.
  540. </summary>
  541. <param name="data">The data to process.</param>
  542. <param name="offset">The offset into the byte array from which to begin using data.</param>
  543. <param name="count">The number of bytes in the array to use as data.</param>
  544. <exception cref="T:System.ArgumentNullException"><paramref name="data"/> is <c>null</c>.</exception>
  545. <exception cref="T:System.ArgumentOutOfRangeException">
  546. <paramref name="offset"/> is out of range. This parameter requires a non-negative number.
  547. </exception>
  548. <exception cref="T:System.ArgumentOutOfRangeException">
  549. <paramref name="count"/> is out of range. This parameter requires a non-negative number less than
  550. the <see cref="P:System.Array.Length"/> value of <paramref name="data"/>.
  551. </exception>
  552. <exception cref="T:System.ArgumentException">
  553. <paramref name="count"/> is greater than
  554. <paramref name="data"/>.<see cref="P:System.Array.Length"/> - <paramref name="offset"/>.
  555. </exception>
  556. <exception cref="T:System.ObjectDisposedException">The object has already been disposed.</exception>
  557. </member>
  558. <member name="M:System.Security.Cryptography.IncrementalHash.GetHashAndReset">
  559. <summary>
  560. Retrieve the hash or HMAC for the data accumulated from prior calls to
  561. <see cref="M:System.Security.Cryptography.IncrementalHash.AppendData(System.Byte[])"/>, and return to the state the object
  562. was in at construction.
  563. </summary>
  564. <returns>The computed hash or HMAC.</returns>
  565. <exception cref="T:System.ObjectDisposedException">The object has already been disposed.</exception>
  566. </member>
  567. <member name="M:System.Security.Cryptography.IncrementalHash.Dispose">
  568. <summary>
  569. Release all resources used by the current instance of the
  570. <see cref="T:System.Security.Cryptography.IncrementalHash"/> class.
  571. </summary>
  572. </member>
  573. <member name="M:System.Security.Cryptography.IncrementalHash.CreateHash(System.Security.Cryptography.HashAlgorithmName)">
  574. <summary>
  575. Create an <see cref="T:System.Security.Cryptography.IncrementalHash"/> for the algorithm specified by <paramref name="hashAlgorithm"/>.
  576. </summary>
  577. <param name="hashAlgorithm">The name of the hash algorithm to perform.</param>
  578. <returns>
  579. An <see cref="T:System.Security.Cryptography.IncrementalHash"/> instance ready to compute the hash algorithm specified
  580. by <paramref name="hashAlgorithm"/>.
  581. </returns>
  582. <exception cref="T:System.ArgumentException">
  583. <paramref name="hashAlgorithm"/>.<see cref="P:System.Security.Cryptography.HashAlgorithmName.Name"/> is <c>null</c>, or
  584. the empty string.
  585. </exception>
  586. <exception cref="T:System.Security.Cryptography.CryptographicException"><paramref name="hashAlgorithm"/> is not a known hash algorithm.</exception>
  587. </member>
  588. <member name="M:System.Security.Cryptography.IncrementalHash.CreateHMAC(System.Security.Cryptography.HashAlgorithmName,System.Byte[])">
  589. <summary>
  590. Create an <see cref="T:System.Security.Cryptography.IncrementalHash"/> for the Hash-based Message Authentication Code (HMAC)
  591. algorithm utilizing the hash algorithm specified by <paramref name="hashAlgorithm"/>, and a
  592. key specified by <paramref name="key"/>.
  593. </summary>
  594. <param name="hashAlgorithm">The name of the hash algorithm to perform within the HMAC.</param>
  595. <param name="key">
  596. The secret key for the HMAC. The key can be any length, but a key longer than the output size
  597. of the hash algorithm specified by <paramref name="hashAlgorithm"/> will be hashed (using the
  598. algorithm specified by <paramref name="hashAlgorithm"/>) to derive a correctly-sized key. Therefore,
  599. the recommended size of the secret key is the output size of the hash specified by
  600. <paramref name="hashAlgorithm"/>.
  601. </param>
  602. <returns>
  603. An <see cref="T:System.Security.Cryptography.IncrementalHash"/> instance ready to compute the hash algorithm specified
  604. by <paramref name="hashAlgorithm"/>.
  605. </returns>
  606. <exception cref="T:System.ArgumentException">
  607. <paramref name="hashAlgorithm"/>.<see cref="P:System.Security.Cryptography.HashAlgorithmName.Name"/> is <c>null</c>, or
  608. the empty string.
  609. </exception>
  610. <exception cref="T:System.Security.Cryptography.CryptographicException"><paramref name="hashAlgorithm"/> is not a known hash algorithm.</exception>
  611. </member>
  612. <member name="P:System.SR.Argument_InvalidOffLen">
  613. <summary>Offset and length were out of bounds for the array or count is greater than the number of elements from index to the end of the source collection.</summary>
  614. </member>
  615. <member name="P:System.SR.ArgumentOutOfRange_NeedNonNegNum">
  616. <summary>Non-negative number required.</summary>
  617. </member>
  618. <member name="P:System.SR.Error_FileSystemWatcherRequiredWithoutPolling">
  619. <summary>The fileSystemWatcher parameter must be non-null when pollForChanges is false.</summary>
  620. </member>
  621. <member name="P:System.SR.CannotCreateStream">
  622. <summary>Cannot create a stream for a directory.</summary>
  623. </member>
  624. <member name="P:System.SR.CannotModifyWhenFileWatcherInitialized">
  625. <summary>Cannot modify {0} once file watcher has been initialized.</summary>
  626. </member>
  627. <member name="P:System.SR.Cryptography_HashAlgorithmNameNullOrEmpty">
  628. <summary>The hash algorithm name cannot be null or empty.</summary>
  629. </member>
  630. <member name="P:System.SR.UnexpectedFileSystemInfo">
  631. <summary>Unexpected type of FileSystemInfo</summary>
  632. </member>
  633. <member name="P:System.SR.FileSystemWatcher_PlatformNotSupported">
  634. <summary>The type '{0}' is not supported on this platform, use polling instead.</summary>
  635. </member>
  636. <member name="T:System.Diagnostics.CodeAnalysis.AllowNullAttribute">
  637. <summary>Specifies that null is allowed as an input even if the corresponding type disallows it.</summary>
  638. </member>
  639. <member name="T:System.Diagnostics.CodeAnalysis.DisallowNullAttribute">
  640. <summary>Specifies that null is disallowed as an input even if the corresponding type allows it.</summary>
  641. </member>
  642. <member name="T:System.Diagnostics.CodeAnalysis.MaybeNullAttribute">
  643. <summary>Specifies that an output may be null even if the corresponding type disallows it.</summary>
  644. </member>
  645. <member name="T:System.Diagnostics.CodeAnalysis.NotNullAttribute">
  646. <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>
  647. </member>
  648. <member name="T:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute">
  649. <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>
  650. </member>
  651. <member name="M:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.#ctor(System.Boolean)">
  652. <summary>Initializes the attribute with the specified return value condition.</summary>
  653. <param name="returnValue">
  654. The return value condition. If the method returns this value, the associated parameter may be null.
  655. </param>
  656. </member>
  657. <member name="P:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.ReturnValue">
  658. <summary>Gets the return value condition.</summary>
  659. </member>
  660. <member name="T:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute">
  661. <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>
  662. </member>
  663. <member name="M:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.#ctor(System.Boolean)">
  664. <summary>Initializes the attribute with the specified return value condition.</summary>
  665. <param name="returnValue">
  666. The return value condition. If the method returns this value, the associated parameter will not be null.
  667. </param>
  668. </member>
  669. <member name="P:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.ReturnValue">
  670. <summary>Gets the return value condition.</summary>
  671. </member>
  672. <member name="T:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute">
  673. <summary>Specifies that the output will be non-null if the named parameter is non-null.</summary>
  674. </member>
  675. <member name="M:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute.#ctor(System.String)">
  676. <summary>Initializes the attribute with the associated parameter name.</summary>
  677. <param name="parameterName">
  678. The associated parameter name. The output will be non-null if the argument to the parameter specified is non-null.
  679. </param>
  680. </member>
  681. <member name="P:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute.ParameterName">
  682. <summary>Gets the associated parameter name.</summary>
  683. </member>
  684. <member name="T:System.Diagnostics.CodeAnalysis.DoesNotReturnAttribute">
  685. <summary>Applied to a method that will never return under any circumstance.</summary>
  686. </member>
  687. <member name="T:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute">
  688. <summary>Specifies that the method will not return if the associated Boolean parameter is passed the specified value.</summary>
  689. </member>
  690. <member name="M:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute.#ctor(System.Boolean)">
  691. <summary>Initializes the attribute with the specified parameter value.</summary>
  692. <param name="parameterValue">
  693. The condition parameter value. Code after the method will be considered unreachable by diagnostics if the argument to
  694. the associated parameter matches this value.
  695. </param>
  696. </member>
  697. <member name="P:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute.ParameterValue">
  698. <summary>Gets the condition parameter value.</summary>
  699. </member>
  700. <member name="T:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute">
  701. <summary>Specifies that the method or property will ensure that the listed field and property members have not-null values.</summary>
  702. </member>
  703. <member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.#ctor(System.String)">
  704. <summary>Initializes the attribute with a field or property member.</summary>
  705. <param name="member">
  706. The field or property member that is promised to be not-null.
  707. </param>
  708. </member>
  709. <member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.#ctor(System.String[])">
  710. <summary>Initializes the attribute with the list of field and property members.</summary>
  711. <param name="members">
  712. The list of field and property members that are promised to be not-null.
  713. </param>
  714. </member>
  715. <member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.Members">
  716. <summary>Gets field or property member names.</summary>
  717. </member>
  718. <member name="T:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute">
  719. <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>
  720. </member>
  721. <member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.#ctor(System.Boolean,System.String)">
  722. <summary>Initializes the attribute with the specified return value condition and a field or property member.</summary>
  723. <param name="returnValue">
  724. The return value condition. If the method returns this value, the associated parameter will not be null.
  725. </param>
  726. <param name="member">
  727. The field or property member that is promised to be not-null.
  728. </param>
  729. </member>
  730. <member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.#ctor(System.Boolean,System.String[])">
  731. <summary>Initializes the attribute with the specified return value condition and list of field and property members.</summary>
  732. <param name="returnValue">
  733. The return value condition. If the method returns this value, the associated parameter will not be null.
  734. </param>
  735. <param name="members">
  736. The list of field and property members that are promised to be not-null.
  737. </param>
  738. </member>
  739. <member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.ReturnValue">
  740. <summary>Gets the return value condition.</summary>
  741. </member>
  742. <member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.Members">
  743. <summary>Gets field or property member names.</summary>
  744. </member>
  745. </members>
  746. </doc>