System.IO.Ports.xml 22 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>System.IO.Ports</name>
  5. </assembly>
  6. <members>
  7. <member name="P:System.SR.IO_EOF_ReadBeyondEOF">
  8. <summary>Unable to read beyond the end of the stream.</summary>
  9. </member>
  10. <member name="P:System.SR.BaseStream_Invalid_Not_Open">
  11. <summary>The BaseStream is only available when the port is open.</summary>
  12. </member>
  13. <member name="P:System.SR.PortNameEmpty_String">
  14. <summary>The PortName cannot be empty.</summary>
  15. </member>
  16. <member name="P:System.SR.Port_not_open">
  17. <summary>The port is closed.</summary>
  18. </member>
  19. <member name="P:System.SR.Port_already_open">
  20. <summary>The port is already open.</summary>
  21. </member>
  22. <member name="P:System.SR.Cant_be_set_when_open">
  23. <summary>'{0}' cannot be set while the port is open.</summary>
  24. </member>
  25. <member name="P:System.SR.Max_Baud">
  26. <summary>The maximum baud rate for the device is {0}.</summary>
  27. </member>
  28. <member name="P:System.SR.In_Break_State">
  29. <summary>The port is in the break state and cannot be written to.</summary>
  30. </member>
  31. <member name="P:System.SR.Write_timed_out">
  32. <summary>The write timed out.</summary>
  33. </member>
  34. <member name="P:System.SR.CantSetRtsWithHandshaking">
  35. <summary>RtsEnable cannot be accessed if Handshake is set to RequestToSend or RequestToSendXOnXOff.</summary>
  36. </member>
  37. <member name="P:System.SR.NotSupportedEncoding">
  38. <summary>SerialPort does not support encoding '{0}'. The supported encodings include ASCIIEncoding, UTF8Encoding, UnicodeEncoding, UTF32Encoding, and most single or double byte code pages. For a complete list please see the documentation.</summary>
  39. </member>
  40. <member name="P:System.SR.Arg_InvalidSerialPort">
  41. <summary>The given port name ({0}) does not resolve to a valid serial port.</summary>
  42. </member>
  43. <member name="P:System.SR.Arg_InvalidSerialPortExtended">
  44. <summary>The given port name is invalid. It may be a valid port, but not a serial port.</summary>
  45. </member>
  46. <member name="P:System.SR.Argument_InvalidOffLen">
  47. <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>
  48. </member>
  49. <member name="P:System.SR.ArgumentOutOfRange_Bounds_Lower_Upper">
  50. <summary>Argument must be between {0} and {1}.</summary>
  51. </member>
  52. <member name="P:System.SR.ArgumentOutOfRange_Enum">
  53. <summary>Enum value was out of legal range.</summary>
  54. </member>
  55. <member name="P:System.SR.ArgumentOutOfRange_NeedNonNegNumRequired">
  56. <summary>Non-negative number required.</summary>
  57. </member>
  58. <member name="P:System.SR.ArgumentOutOfRange_NeedPosNum">
  59. <summary>Positive number required.</summary>
  60. </member>
  61. <member name="P:System.SR.ArgumentOutOfRange_Timeout">
  62. <summary>The timeout must be greater than or equal to -1.</summary>
  63. </member>
  64. <member name="P:System.SR.ArgumentOutOfRange_WriteTimeout">
  65. <summary>The timeout must be either a positive number or -1.</summary>
  66. </member>
  67. <member name="P:System.SR.IndexOutOfRange_IORaceCondition">
  68. <summary>Probable I/O race condition detected while copying memory. The I/O package is not thread safe by default. In multithreaded applications, a stream must be accessed in a thread-safe way, such as a thread-safe wrapper returned by TextReader's or TextWriter's ...</summary>
  69. </member>
  70. <member name="P:System.SR.IO_OperationAborted">
  71. <summary>The I/O operation has been aborted because of either a thread exit or an application request.</summary>
  72. </member>
  73. <member name="P:System.SR.NotSupported_UnseekableStream">
  74. <summary>Stream does not support seeking.</summary>
  75. </member>
  76. <member name="P:System.SR.ObjectDisposed_StreamClosed">
  77. <summary>Cannot access a closed stream.</summary>
  78. </member>
  79. <member name="P:System.SR.InvalidNullEmptyArgument">
  80. <summary>Argument {0} cannot be null or zero-length.</summary>
  81. </member>
  82. <member name="P:System.SR.Arg_WrongAsyncResult">
  83. <summary>IAsyncResult object did not come from the corresponding async method on this type.</summary>
  84. </member>
  85. <member name="P:System.SR.InvalidOperation_EndReadCalledMultiple">
  86. <summary>EndRead can only be called once for each asynchronous operation.</summary>
  87. </member>
  88. <member name="P:System.SR.InvalidOperation_EndWriteCalledMultiple">
  89. <summary>EndWrite can only be called once for each asynchronous operation.</summary>
  90. </member>
  91. <member name="P:System.SR.UnauthorizedAccess_IODenied_Port">
  92. <summary>Access to the port '{0}' is denied.</summary>
  93. </member>
  94. <member name="P:System.SR.PlatformNotSupported_IOPorts">
  95. <summary>System.IO.Ports is currently only supported on Windows.</summary>
  96. </member>
  97. <member name="P:System.SR.PlatformNotSupported_SerialPort_GetPortNames">
  98. <summary>Enumeration of serial port names is not supported on the current platform.</summary>
  99. </member>
  100. <member name="P:System.SR.IO_PathTooLong">
  101. <summary>The specified file name or path is too long, or a component of the specified path is too long.</summary>
  102. </member>
  103. <member name="P:System.SR.IO_PathNotFound_NoPathName">
  104. <summary>Could not find a part of the path.</summary>
  105. </member>
  106. <member name="P:System.SR.IO_PathNotFound_Path">
  107. <summary>Could not find a part of the path '{0}'.</summary>
  108. </member>
  109. <member name="P:System.SR.IO_FileNotFound">
  110. <summary>Unable to find the specified file.</summary>
  111. </member>
  112. <member name="P:System.SR.IO_FileNotFound_FileName">
  113. <summary>Could not find file '{0}'.</summary>
  114. </member>
  115. <member name="P:System.SR.UnauthorizedAccess_IODenied_NoPathName">
  116. <summary>Access to the path is denied.</summary>
  117. </member>
  118. <member name="P:System.SR.UnauthorizedAccess_IODenied_Path">
  119. <summary>Access to the path '{0}' is denied.</summary>
  120. </member>
  121. <member name="P:System.SR.IO_PathTooLong_Path">
  122. <summary>The path '{0}' is too long, or a component of the specified path is too long.</summary>
  123. </member>
  124. <member name="P:System.SR.IO_SharingViolation_File">
  125. <summary>The process cannot access the file '{0}' because it is being used by another process.</summary>
  126. </member>
  127. <member name="P:System.SR.IO_SharingViolation_NoFileName">
  128. <summary>The process cannot access the file because it is being used by another process.</summary>
  129. </member>
  130. <member name="P:System.SR.ArgumentOutOfRange_FileLengthTooBig">
  131. <summary>Specified file length was too large for the file system.</summary>
  132. </member>
  133. <member name="P:System.SR.IO_FileExists_Name">
  134. <summary>The file '{0}' already exists.</summary>
  135. </member>
  136. <member name="P:System.SR.IO_AlreadyExists_Name">
  137. <summary>Cannot create '{0}' because a file or directory with the same name already exists.</summary>
  138. </member>
  139. <member name="T:System.Runtime.InteropServices.LibraryImportAttribute">
  140. <summary>
  141. Attribute used to indicate a source generator should create a function for marshalling
  142. arguments instead of relying on the runtime to generate an equivalent marshalling function at run-time.
  143. </summary>
  144. <remarks>
  145. This attribute is meaningless if the source generator associated with it is not enabled.
  146. The current built-in source generator only supports C# and only supplies an implementation when
  147. applied to static, partial, non-generic methods.
  148. </remarks>
  149. </member>
  150. <member name="M:System.Runtime.InteropServices.LibraryImportAttribute.#ctor(System.String)">
  151. <summary>
  152. Initializes a new instance of the <see cref="T:System.Runtime.InteropServices.LibraryImportAttribute"/>.
  153. </summary>
  154. <param name="libraryName">Name of the library containing the import.</param>
  155. </member>
  156. <member name="P:System.Runtime.InteropServices.LibraryImportAttribute.LibraryName">
  157. <summary>
  158. Gets the name of the library containing the import.
  159. </summary>
  160. </member>
  161. <member name="P:System.Runtime.InteropServices.LibraryImportAttribute.EntryPoint">
  162. <summary>
  163. Gets or sets the name of the entry point to be called.
  164. </summary>
  165. </member>
  166. <member name="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshalling">
  167. <summary>
  168. Gets or sets how to marshal string arguments to the method.
  169. </summary>
  170. <remarks>
  171. If this field is set to a value other than <see cref="F:System.Runtime.InteropServices.StringMarshalling.Custom" />,
  172. <see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType" /> must not be specified.
  173. </remarks>
  174. </member>
  175. <member name="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType">
  176. <summary>
  177. Gets or sets the <see cref="T:System.Type"/> used to control how string arguments to the method are marshalled.
  178. </summary>
  179. <remarks>
  180. If this field is specified, <see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshalling" /> must not be specified
  181. or must be set to <see cref="F:System.Runtime.InteropServices.StringMarshalling.Custom" />.
  182. </remarks>
  183. </member>
  184. <member name="P:System.Runtime.InteropServices.LibraryImportAttribute.SetLastError">
  185. <summary>
  186. Gets or sets whether the callee sets an error (SetLastError on Windows or errno
  187. on other platforms) before returning from the attributed method.
  188. </summary>
  189. </member>
  190. <member name="T:System.Runtime.InteropServices.StringMarshalling">
  191. <summary>
  192. Specifies how strings should be marshalled for generated p/invokes
  193. </summary>
  194. </member>
  195. <member name="F:System.Runtime.InteropServices.StringMarshalling.Custom">
  196. <summary>
  197. Indicates the user is suppling a specific marshaller in <see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType"/>.
  198. </summary>
  199. </member>
  200. <member name="F:System.Runtime.InteropServices.StringMarshalling.Utf8">
  201. <summary>
  202. Use the platform-provided UTF-8 marshaller.
  203. </summary>
  204. </member>
  205. <member name="F:System.Runtime.InteropServices.StringMarshalling.Utf16">
  206. <summary>
  207. Use the platform-provided UTF-16 marshaller.
  208. </summary>
  209. </member>
  210. <member name="T:System.Runtime.Versioning.OSPlatformAttribute">
  211. <summary>
  212. Base type for all platform-specific API attributes.
  213. </summary>
  214. </member>
  215. <member name="T:System.Runtime.Versioning.TargetPlatformAttribute">
  216. <summary>
  217. Records the platform that the project targeted.
  218. </summary>
  219. </member>
  220. <member name="T:System.Runtime.Versioning.SupportedOSPlatformAttribute">
  221. <summary>
  222. Records the operating system (and minimum version) that supports an API. Multiple attributes can be
  223. applied to indicate support on multiple operating systems.
  224. </summary>
  225. <remarks>
  226. Callers can apply a <see cref="T:System.Runtime.Versioning.SupportedOSPlatformAttribute" />
  227. or use guards to prevent calls to APIs on unsupported operating systems.
  228. A given platform should only be specified once.
  229. </remarks>
  230. </member>
  231. <member name="T:System.Runtime.Versioning.UnsupportedOSPlatformAttribute">
  232. <summary>
  233. Marks APIs that were removed in a given operating system version.
  234. </summary>
  235. <remarks>
  236. Primarily used by OS bindings to indicate APIs that are only available in
  237. earlier versions.
  238. </remarks>
  239. </member>
  240. <member name="T:System.Runtime.Versioning.ObsoletedOSPlatformAttribute">
  241. <summary>
  242. Marks APIs that were obsoleted in a given operating system version.
  243. </summary>
  244. <remarks>
  245. Primarily used by OS bindings to indicate APIs that should not be used anymore.
  246. </remarks>
  247. </member>
  248. <member name="T:System.Runtime.Versioning.SupportedOSPlatformGuardAttribute">
  249. <summary>
  250. Annotates a custom guard field, property or method with a supported platform name and optional version.
  251. Multiple attributes can be applied to indicate guard for multiple supported platforms.
  252. </summary>
  253. <remarks>
  254. Callers can apply a <see cref="T:System.Runtime.Versioning.SupportedOSPlatformGuardAttribute" /> to a field, property or method
  255. and use that field, property or method in a conditional or assert statements in order to safely call platform specific APIs.
  256. 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.
  257. </remarks>
  258. </member>
  259. <member name="T:System.Runtime.Versioning.UnsupportedOSPlatformGuardAttribute">
  260. <summary>
  261. Annotates the custom guard field, property or method with an unsupported platform name and optional version.
  262. Multiple attributes can be applied to indicate guard for multiple unsupported platforms.
  263. </summary>
  264. <remarks>
  265. Callers can apply a <see cref="T:System.Runtime.Versioning.UnsupportedOSPlatformGuardAttribute" /> to a field, property or method
  266. and use that field, property or method in a conditional or assert statements as a guard to safely call APIs unsupported on those platforms.
  267. 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.
  268. </remarks>
  269. </member>
  270. <member name="T:System.Diagnostics.CodeAnalysis.AllowNullAttribute">
  271. <summary>Specifies that null is allowed as an input even if the corresponding type disallows it.</summary>
  272. </member>
  273. <member name="T:System.Diagnostics.CodeAnalysis.DisallowNullAttribute">
  274. <summary>Specifies that null is disallowed as an input even if the corresponding type allows it.</summary>
  275. </member>
  276. <member name="T:System.Diagnostics.CodeAnalysis.MaybeNullAttribute">
  277. <summary>Specifies that an output may be null even if the corresponding type disallows it.</summary>
  278. </member>
  279. <member name="T:System.Diagnostics.CodeAnalysis.NotNullAttribute">
  280. <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>
  281. </member>
  282. <member name="T:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute">
  283. <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>
  284. </member>
  285. <member name="M:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.#ctor(System.Boolean)">
  286. <summary>Initializes the attribute with the specified return value condition.</summary>
  287. <param name="returnValue">
  288. The return value condition. If the method returns this value, the associated parameter may be null.
  289. </param>
  290. </member>
  291. <member name="P:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.ReturnValue">
  292. <summary>Gets the return value condition.</summary>
  293. </member>
  294. <member name="T:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute">
  295. <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>
  296. </member>
  297. <member name="M:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.#ctor(System.Boolean)">
  298. <summary>Initializes the attribute with the specified return value condition.</summary>
  299. <param name="returnValue">
  300. The return value condition. If the method returns this value, the associated parameter will not be null.
  301. </param>
  302. </member>
  303. <member name="P:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.ReturnValue">
  304. <summary>Gets the return value condition.</summary>
  305. </member>
  306. <member name="T:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute">
  307. <summary>Specifies that the output will be non-null if the named parameter is non-null.</summary>
  308. </member>
  309. <member name="M:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute.#ctor(System.String)">
  310. <summary>Initializes the attribute with the associated parameter name.</summary>
  311. <param name="parameterName">
  312. The associated parameter name. The output will be non-null if the argument to the parameter specified is non-null.
  313. </param>
  314. </member>
  315. <member name="P:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute.ParameterName">
  316. <summary>Gets the associated parameter name.</summary>
  317. </member>
  318. <member name="T:System.Diagnostics.CodeAnalysis.DoesNotReturnAttribute">
  319. <summary>Applied to a method that will never return under any circumstance.</summary>
  320. </member>
  321. <member name="T:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute">
  322. <summary>Specifies that the method will not return if the associated Boolean parameter is passed the specified value.</summary>
  323. </member>
  324. <member name="M:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute.#ctor(System.Boolean)">
  325. <summary>Initializes the attribute with the specified parameter value.</summary>
  326. <param name="parameterValue">
  327. The condition parameter value. Code after the method will be considered unreachable by diagnostics if the argument to
  328. the associated parameter matches this value.
  329. </param>
  330. </member>
  331. <member name="P:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute.ParameterValue">
  332. <summary>Gets the condition parameter value.</summary>
  333. </member>
  334. <member name="T:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute">
  335. <summary>Specifies that the method or property will ensure that the listed field and property members have not-null values.</summary>
  336. </member>
  337. <member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.#ctor(System.String)">
  338. <summary>Initializes the attribute with a field or property member.</summary>
  339. <param name="member">
  340. The field or property member that is promised to be not-null.
  341. </param>
  342. </member>
  343. <member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.#ctor(System.String[])">
  344. <summary>Initializes the attribute with the list of field and property members.</summary>
  345. <param name="members">
  346. The list of field and property members that are promised to be not-null.
  347. </param>
  348. </member>
  349. <member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.Members">
  350. <summary>Gets field or property member names.</summary>
  351. </member>
  352. <member name="T:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute">
  353. <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>
  354. </member>
  355. <member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.#ctor(System.Boolean,System.String)">
  356. <summary>Initializes the attribute with the specified return value condition and a field or property member.</summary>
  357. <param name="returnValue">
  358. The return value condition. If the method returns this value, the associated parameter will not be null.
  359. </param>
  360. <param name="member">
  361. The field or property member that is promised to be not-null.
  362. </param>
  363. </member>
  364. <member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.#ctor(System.Boolean,System.String[])">
  365. <summary>Initializes the attribute with the specified return value condition and list of field and property members.</summary>
  366. <param name="returnValue">
  367. The return value condition. If the method returns this value, the associated parameter will not be null.
  368. </param>
  369. <param name="members">
  370. The list of field and property members that are promised to be not-null.
  371. </param>
  372. </member>
  373. <member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.ReturnValue">
  374. <summary>Gets the return value condition.</summary>
  375. </member>
  376. <member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.Members">
  377. <summary>Gets field or property member names.</summary>
  378. </member>
  379. </members>
  380. </doc>