PipeStream.xml 57 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976
  1. <?xml version="1.0" encoding="utf-8"?>
  2. <Type Name="PipeStream" FullName="System.IO.Pipes.PipeStream">
  3. <TypeSignature Language="C#" Value="public abstract class PipeStream : System.IO.Stream" />
  4. <TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit PipeStream extends System.IO.Stream" />
  5. <AssemblyInfo>
  6. <AssemblyName>System.Core</AssemblyName>
  7. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  8. </AssemblyInfo>
  9. <Base>
  10. <BaseTypeName>System.IO.Stream</BaseTypeName>
  11. </Base>
  12. <Interfaces />
  13. <Docs>
  14. <remarks>
  15. <attribution license="cc4" from="Microsoft" modified="false" />
  16. <para>The <see cref="T:System.IO.Pipes.PipeStream" /> class provides the base class for named and anonymous pipes operations in the .NET Framework. Use the <see cref="T:System.IO.Pipes.NamedPipeServerStream" /> and <see cref="T:System.IO.Pipes.NamedPipeClientStream" /> classes for named pipe operations. Use the <see cref="T:System.IO.Pipes.AnonymousPipeServerStream" /> and <see cref="T:System.IO.Pipes.AnonymousPipeClientStream" /> classes for anonymous pipe operations.</para>
  17. <para>For more information about pipes, see <format type="text/html"><a href="7b964ebd-7a4f-4d28-8194-7841f9e4c702">Pipes</a></format>. For an example of anonymous pipes, see <format type="text/html"><a href="e7773c77-c646-4a01-8a96-a003d59fc4c9">How to: Use Anonymous Pipes to Communicate Between Local Processes</a></format>. For an example of named pipes, see <format type="text/html"><a href="4e4d7e64-9f1b-4026-98f7-20488ac7b42b">How to: Use Named Pipes to Communicate Between Processes over a Network</a></format>.</para>
  18. </remarks>
  19. <summary>
  20. <attribution license="cc4" from="Microsoft" modified="false" />
  21. <para>Exposes a <see cref="T:System.IO.Stream" /> object around a pipe, which supports both anonymous and named pipes.</para>
  22. </summary>
  23. </Docs>
  24. <Members>
  25. <Member MemberName=".ctor">
  26. <MemberSignature Language="C#" Value="protected PipeStream (System.IO.Pipes.PipeDirection direction, int bufferSize);" />
  27. <MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor(valuetype System.IO.Pipes.PipeDirection direction, int32 bufferSize) cil managed" />
  28. <MemberType>Constructor</MemberType>
  29. <AssemblyInfo>
  30. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  31. </AssemblyInfo>
  32. <Parameters>
  33. <Parameter Name="direction" Type="System.IO.Pipes.PipeDirection" />
  34. <Parameter Name="bufferSize" Type="System.Int32" />
  35. </Parameters>
  36. <Docs>
  37. <remarks>
  38. <attribution license="cc4" from="Microsoft" modified="false" />
  39. <para>This constructor uses a pipe transmission mode of <see cref="F:System.IO.Pipes.PipeTransmissionMode.Byte" />.</para>
  40. </remarks>
  41. <summary>
  42. <attribution license="cc4" from="Microsoft" modified="false" />
  43. <para>Initializes a new instance of the <see cref="T:System.IO.Pipes.PipeStream" /> class using the specified <see cref="T:System.IO.Pipes.PipeDirection" /> value and buffer size.</para>
  44. </summary>
  45. <param name="direction">
  46. <attribution license="cc4" from="Microsoft" modified="false" />One of the <see cref="T:System.IO.Pipes.PipeDirection" /> values that indicates the direction of the pipe object.</param>
  47. <param name="bufferSize">
  48. <attribution license="cc4" from="Microsoft" modified="false" />A positive <see cref="T:System.Int32" /> value greater than or equal to 0 that indicates the buffer size.</param>
  49. </Docs>
  50. </Member>
  51. <Member MemberName=".ctor">
  52. <MemberSignature Language="C#" Value="protected PipeStream (System.IO.Pipes.PipeDirection direction, System.IO.Pipes.PipeTransmissionMode transmissionMode, int outBufferSize);" />
  53. <MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor(valuetype System.IO.Pipes.PipeDirection direction, valuetype System.IO.Pipes.PipeTransmissionMode transmissionMode, int32 outBufferSize) cil managed" />
  54. <MemberType>Constructor</MemberType>
  55. <AssemblyInfo>
  56. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  57. </AssemblyInfo>
  58. <Parameters>
  59. <Parameter Name="direction" Type="System.IO.Pipes.PipeDirection" />
  60. <Parameter Name="transmissionMode" Type="System.IO.Pipes.PipeTransmissionMode" />
  61. <Parameter Name="outBufferSize" Type="System.Int32" />
  62. </Parameters>
  63. <Docs>
  64. <remarks>To be added.</remarks>
  65. <summary>
  66. <attribution license="cc4" from="Microsoft" modified="false" />
  67. <para>Initializes a new instance of the <see cref="T:System.IO.Pipes.PipeStream" /> class using the specified <see cref="T:System.IO.Pipes.PipeDirection" />, <see cref="T:System.IO.Pipes.PipeTransmissionMode" />, and buffer size.</para>
  68. </summary>
  69. <param name="direction">
  70. <attribution license="cc4" from="Microsoft" modified="false" />One of the <see cref="T:System.IO.Pipes.PipeDirection" /> values that indicates the direction of the pipe object.</param>
  71. <param name="transmissionMode">
  72. <attribution license="cc4" from="Microsoft" modified="false" />One of the <see cref="T:System.IO.Pipes.PipeTransmissionMode" /> values that indicates the transmission mode of the pipe object.</param>
  73. <param name="outBufferSize">
  74. <attribution license="cc4" from="Microsoft" modified="false" />A positive <see cref="T:System.Int32" /> value greater than or equal to 0 that indicates the buffer size.</param>
  75. </Docs>
  76. </Member>
  77. <Member MemberName="BeginRead">
  78. <MemberSignature Language="C#" Value="public override IAsyncResult BeginRead (byte[] buffer, int offset, int count, AsyncCallback callback, object state);" />
  79. <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance class System.IAsyncResult BeginRead(unsigned int8[] buffer, int32 offset, int32 count, class System.AsyncCallback callback, object state) cil managed" />
  80. <MemberType>Method</MemberType>
  81. <AssemblyInfo>
  82. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  83. </AssemblyInfo>
  84. <ReturnValue>
  85. <ReturnType>System.IAsyncResult</ReturnType>
  86. </ReturnValue>
  87. <Parameters>
  88. <Parameter Name="buffer" Type="System.Byte[]" />
  89. <Parameter Name="offset" Type="System.Int32" />
  90. <Parameter Name="count" Type="System.Int32" />
  91. <Parameter Name="callback" Type="System.AsyncCallback" />
  92. <Parameter Name="state" Type="System.Object" />
  93. </Parameters>
  94. <Docs>
  95. <remarks>
  96. <attribution license="cc4" from="Microsoft" modified="false" />
  97. <para>Pass the returned <see cref="T:System.IAsyncResult" /> object to the <see cref="M:System.IO.Pipes.PipeStream.EndRead(System.IAsyncResult)" /> method to determine how many bytes were read and to release operating system resources used for reading. <see cref="M:System.IO.Pipes.PipeStream.EndRead(System.IAsyncResult)" /> must be called once for every call to <see cref="M:System.IO.Pipes.PipeStream.BeginRead(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object)" />. This can be done either in the same code that called <see cref="M:System.IO.Pipes.PipeStream.BeginRead(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object)" /> or in a callback that is passed to <see cref="M:System.IO.Pipes.PipeStream.BeginRead(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object)" />.</para>
  98. <para>Use the <see cref="P:System.IO.Pipes.PipeStream.CanRead" /> property to determine whether the current <see cref="T:System.IO.Pipes.PipeStream" /> object supports read operations.</para>
  99. <para>If the pipe is closed or an invalid argument is passed to <see cref="M:System.IO.Pipes.PipeStream.BeginRead(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object)" />, the appropriate exceptions are raised immediately. Errors that occur during an asynchronous read request occur on the thread pool thread that is performing the request. The exceptions are raised when the code calls the <see cref="M:System.IO.Pipes.PipeStream.EndRead(System.IAsyncResult)" /> method.</para>
  100. </remarks>
  101. <summary>
  102. <attribution license="cc4" from="Microsoft" modified="false" />
  103. <para>Begins an asynchronous read operation.</para>
  104. </summary>
  105. <returns>
  106. <attribution license="cc4" from="Microsoft" modified="false" />
  107. <para>An <see cref="T:System.IAsyncResult" /> object that references the asynchronous read.</para>
  108. </returns>
  109. <param name="buffer">
  110. <attribution license="cc4" from="Microsoft" modified="false" />The buffer to read data into.</param>
  111. <param name="offset">
  112. <attribution license="cc4" from="Microsoft" modified="false" />The byte offset in <paramref name="buffer" /> at which to begin reading.</param>
  113. <param name="count">
  114. <attribution license="cc4" from="Microsoft" modified="false" />The maximum number of bytes to read.</param>
  115. <param name="callback">
  116. <attribution license="cc4" from="Microsoft" modified="false" />The method to call when the asynchronous read operation is completed.</param>
  117. <param name="state">
  118. <attribution license="cc4" from="Microsoft" modified="false" />A user-provided object that distinguishes this particular asynchronous read request from other requests.</param>
  119. </Docs>
  120. </Member>
  121. <Member MemberName="BeginWrite">
  122. <MemberSignature Language="C#" Value="public override IAsyncResult BeginWrite (byte[] buffer, int offset, int count, AsyncCallback callback, object state);" />
  123. <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance class System.IAsyncResult BeginWrite(unsigned int8[] buffer, int32 offset, int32 count, class System.AsyncCallback callback, object state) cil managed" />
  124. <MemberType>Method</MemberType>
  125. <AssemblyInfo>
  126. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  127. </AssemblyInfo>
  128. <ReturnValue>
  129. <ReturnType>System.IAsyncResult</ReturnType>
  130. </ReturnValue>
  131. <Parameters>
  132. <Parameter Name="buffer" Type="System.Byte[]" />
  133. <Parameter Name="offset" Type="System.Int32" />
  134. <Parameter Name="count" Type="System.Int32" />
  135. <Parameter Name="callback" Type="System.AsyncCallback" />
  136. <Parameter Name="state" Type="System.Object" />
  137. </Parameters>
  138. <Docs>
  139. <remarks>
  140. <attribution license="cc4" from="Microsoft" modified="false" />
  141. <para>
  142. <see cref="M:System.IO.Pipes.PipeStream.EndWrite(System.IAsyncResult)" /> must be called once for every call to <see cref="M:System.IO.Pipes.PipeStream.BeginWrite(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object)" />. This can be done either in the same code that called <see cref="M:System.IO.Pipes.PipeStream.BeginWrite(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object)" /> or in a callback that is passed to <see cref="M:System.IO.Pipes.PipeStream.BeginWrite(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object)" />.</para>
  143. <para>Use the <see cref="P:System.IO.Pipes.PipeStream.CanWrite" /> property to determine whether the current <see cref="T:System.IO.Pipes.PipeStream" /> object supports write operations.</para>
  144. <para>If the pipe is closed or an invalid argument is passed to <see cref="M:System.IO.Pipes.PipeStream.BeginWrite(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object)" />, the appropriate exceptions are raised immediately. Errors that occur during an asynchronous write request occur on the thread pool thread that is performing the request. The exceptions are raised when the code calls the <see cref="M:System.IO.Pipes.PipeStream.EndWrite(System.IAsyncResult)" /> method.</para>
  145. </remarks>
  146. <summary>
  147. <attribution license="cc4" from="Microsoft" modified="false" />
  148. <para>Begins an asynchronous write operation.</para>
  149. </summary>
  150. <returns>
  151. <attribution license="cc4" from="Microsoft" modified="false" />
  152. <para>An <see cref="T:System.IAsyncResult" /> object that references the asynchronous write operation.</para>
  153. </returns>
  154. <param name="buffer">
  155. <attribution license="cc4" from="Microsoft" modified="false" />The buffer that contains the data to write to the current stream.</param>
  156. <param name="offset">
  157. <attribution license="cc4" from="Microsoft" modified="false" />The zero-based byte offset in <paramref name="buffer" /> at which to begin copying bytes to the current stream.</param>
  158. <param name="count">
  159. <attribution license="cc4" from="Microsoft" modified="false" />The maximum number of bytes to write.</param>
  160. <param name="callback">
  161. <attribution license="cc4" from="Microsoft" modified="false" />The method to call when the asynchronous write operation is completed.</param>
  162. <param name="state">
  163. <attribution license="cc4" from="Microsoft" modified="false" />A user-provided object that distinguishes this particular asynchronous write request from other requests.</param>
  164. </Docs>
  165. </Member>
  166. <Member MemberName="CanRead">
  167. <MemberSignature Language="C#" Value="public override bool CanRead { get; }" />
  168. <MemberSignature Language="ILAsm" Value=".property instance bool CanRead" />
  169. <MemberType>Property</MemberType>
  170. <AssemblyInfo>
  171. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  172. </AssemblyInfo>
  173. <ReturnValue>
  174. <ReturnType>System.Boolean</ReturnType>
  175. </ReturnValue>
  176. <Docs>
  177. <value>To be added.</value>
  178. <remarks>
  179. <attribution license="cc4" from="Microsoft" modified="false" />
  180. <para>If the <see cref="T:System.IO.Pipes.PipeStream" /> object is closed, this property returns false.</para>
  181. </remarks>
  182. <summary>
  183. <attribution license="cc4" from="Microsoft" modified="false" />
  184. <para>Gets a value indicating whether the current stream supports read operations.</para>
  185. </summary>
  186. </Docs>
  187. </Member>
  188. <Member MemberName="CanSeek">
  189. <MemberSignature Language="C#" Value="public override bool CanSeek { get; }" />
  190. <MemberSignature Language="ILAsm" Value=".property instance bool CanSeek" />
  191. <MemberType>Property</MemberType>
  192. <AssemblyInfo>
  193. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  194. </AssemblyInfo>
  195. <ReturnValue>
  196. <ReturnType>System.Boolean</ReturnType>
  197. </ReturnValue>
  198. <Docs>
  199. <value>To be added.</value>
  200. <remarks>
  201. <attribution license="cc4" from="Microsoft" modified="false" />
  202. <para>If the <see cref="T:System.IO.Pipes.PipeStream" /> object is closed, this property returns false.</para>
  203. </remarks>
  204. <summary>
  205. <attribution license="cc4" from="Microsoft" modified="false" />
  206. <para>Gets a value indicating whether the current stream supports seek operations.</para>
  207. </summary>
  208. </Docs>
  209. </Member>
  210. <Member MemberName="CanWrite">
  211. <MemberSignature Language="C#" Value="public override bool CanWrite { get; }" />
  212. <MemberSignature Language="ILAsm" Value=".property instance bool CanWrite" />
  213. <MemberType>Property</MemberType>
  214. <AssemblyInfo>
  215. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  216. </AssemblyInfo>
  217. <ReturnValue>
  218. <ReturnType>System.Boolean</ReturnType>
  219. </ReturnValue>
  220. <Docs>
  221. <value>To be added.</value>
  222. <remarks>
  223. <attribution license="cc4" from="Microsoft" modified="false" />
  224. <para>If the <see cref="T:System.IO.Pipes.PipeStream" /> object is closed, this property returns false.</para>
  225. </remarks>
  226. <summary>
  227. <attribution license="cc4" from="Microsoft" modified="false" />
  228. <para>Gets a value indicating whether the current stream supports write operations.</para>
  229. </summary>
  230. </Docs>
  231. </Member>
  232. <Member MemberName="CheckPipePropertyOperations">
  233. <MemberSignature Language="C#" Value="protected virtual void CheckPipePropertyOperations ();" />
  234. <MemberSignature Language="ILAsm" Value=".method familyorassemblyhidebysig newslot virtual instance void CheckPipePropertyOperations() cil managed" />
  235. <MemberType>Method</MemberType>
  236. <AssemblyInfo>
  237. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  238. </AssemblyInfo>
  239. <Attributes>
  240. <Attribute>
  241. <AttributeName>System.MonoTODO</AttributeName>
  242. </Attribute>
  243. </Attributes>
  244. <ReturnValue>
  245. <ReturnType>System.Void</ReturnType>
  246. </ReturnValue>
  247. <Parameters />
  248. <Docs>
  249. <remarks>To be added.</remarks>
  250. <summary>
  251. <attribution license="cc4" from="Microsoft" modified="false" />
  252. <para>Verifies that the pipe is in a proper state for getting or setting properties.</para>
  253. </summary>
  254. </Docs>
  255. </Member>
  256. <Member MemberName="CheckReadOperations">
  257. <MemberSignature Language="C#" Value="protected void CheckReadOperations ();" />
  258. <MemberSignature Language="ILAsm" Value=".method familyorassemblyhidebysig instance void CheckReadOperations() cil managed" />
  259. <MemberType>Method</MemberType>
  260. <AssemblyInfo>
  261. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  262. </AssemblyInfo>
  263. <Attributes>
  264. <Attribute>
  265. <AttributeName>System.MonoTODO</AttributeName>
  266. </Attribute>
  267. </Attributes>
  268. <ReturnValue>
  269. <ReturnType>System.Void</ReturnType>
  270. </ReturnValue>
  271. <Parameters />
  272. <Docs>
  273. <remarks>To be added.</remarks>
  274. <summary>
  275. <attribution license="cc4" from="Microsoft" modified="false" />
  276. <para>Verifies that the pipe is in a connected state for read operations.</para>
  277. </summary>
  278. </Docs>
  279. </Member>
  280. <Member MemberName="CheckWriteOperations">
  281. <MemberSignature Language="C#" Value="protected void CheckWriteOperations ();" />
  282. <MemberSignature Language="ILAsm" Value=".method familyorassemblyhidebysig instance void CheckWriteOperations() cil managed" />
  283. <MemberType>Method</MemberType>
  284. <AssemblyInfo>
  285. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  286. </AssemblyInfo>
  287. <Attributes>
  288. <Attribute>
  289. <AttributeName>System.MonoTODO</AttributeName>
  290. </Attribute>
  291. </Attributes>
  292. <ReturnValue>
  293. <ReturnType>System.Void</ReturnType>
  294. </ReturnValue>
  295. <Parameters />
  296. <Docs>
  297. <remarks>To be added.</remarks>
  298. <summary>
  299. <attribution license="cc4" from="Microsoft" modified="false" />
  300. <para>Verifies that the pipe is in a connected state for write operations.</para>
  301. </summary>
  302. </Docs>
  303. </Member>
  304. <Member MemberName="Dispose">
  305. <MemberSignature Language="C#" Value="protected override void Dispose (bool disposing);" />
  306. <MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void Dispose(bool disposing) cil managed" />
  307. <MemberType>Method</MemberType>
  308. <AssemblyInfo>
  309. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  310. </AssemblyInfo>
  311. <ReturnValue>
  312. <ReturnType>System.Void</ReturnType>
  313. </ReturnValue>
  314. <Parameters>
  315. <Parameter Name="disposing" Type="System.Boolean" />
  316. </Parameters>
  317. <Docs>
  318. <remarks>
  319. <attribution license="cc4" from="Microsoft" modified="false" />
  320. <para>This method is called by the public <see cref="M:System.ComponentModel.Component.Dispose" /> method and the <see cref="M:System.Object.Finalize" /> method. <see cref="M:System.ComponentModel.Component.Dispose" /> invokes the protected <see cref="M:System.IO.Pipes.PipeStream.Dispose(System.Boolean)" /> method with the <paramref name="disposing" /> parameter set to true. <see cref="M:System.Object.Finalize" /> invokes <see cref="M:System.IO.Pipes.PipeStream.Dispose(System.Boolean)" /> with <paramref name="disposing" /> set to false. When the disposing parameter is true, this method releases all resources held by any managed objects that this <see cref="T:System.IO.Pipes.PipeStream" /> object references. This method invokes the <see cref="M:System.IO.Pipes.PipeStream.Dispose(System.Boolean)" /> method of each referenced object.</para>
  321. </remarks>
  322. <summary>
  323. <attribution license="cc4" from="Microsoft" modified="false" />
  324. <para>Releases the unmanaged resources used by the <see cref="T:System.IO.Pipes.PipeStream" /> class and optionally releases the managed resources.</para>
  325. </summary>
  326. <param name="disposing">
  327. <attribution license="cc4" from="Microsoft" modified="false" />true to release both managed and unmanaged resources; false to release only unmanaged resources.</param>
  328. </Docs>
  329. </Member>
  330. <Member MemberName="EndRead">
  331. <MemberSignature Language="C#" Value="public override int EndRead (IAsyncResult asyncResult);" />
  332. <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance int32 EndRead(class System.IAsyncResult asyncResult) cil managed" />
  333. <MemberType>Method</MemberType>
  334. <AssemblyInfo>
  335. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  336. </AssemblyInfo>
  337. <ReturnValue>
  338. <ReturnType>System.Int32</ReturnType>
  339. </ReturnValue>
  340. <Parameters>
  341. <Parameter Name="asyncResult" Type="System.IAsyncResult" />
  342. </Parameters>
  343. <Docs>
  344. <remarks>
  345. <attribution license="cc4" from="Microsoft" modified="false" />
  346. <para>This method returns the number of bytes read into the byte array specified by the earlier call to <see cref="M:System.IO.Pipes.PipeStream.BeginRead(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object)" />.</para>
  347. <para>Pass the returned <see cref="T:System.IAsyncResult" /> object to the <see cref="M:System.IO.Pipes.PipeStream.EndRead(System.IAsyncResult)" /> method to determine how many bytes were read and to release operating system resources used for reading. <see cref="M:System.IO.Pipes.PipeStream.EndRead(System.IAsyncResult)" /> must be called once for every call to <see cref="M:System.IO.Pipes.PipeStream.BeginRead(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object)" />. This can be done either in the same code that called <see cref="M:System.IO.Pipes.PipeStream.BeginRead(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object)" /> or in a callback that is passed to <see cref="M:System.IO.Pipes.PipeStream.BeginRead(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object)" />.</para>
  348. <para>Use the <see cref="P:System.IO.Pipes.PipeStream.CanRead" /> property to determine whether the current <see cref="T:System.IO.Pipes.PipeStream" /> object supports read operations.</para>
  349. <para>If the pipe is closed or an invalid argument is passed to <see cref="M:System.IO.Pipes.PipeStream.BeginRead(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object)" />, the appropriate exceptions are raised immediately. Errors that occur during an asynchronous read request occur on the thread pool thread that is performing the request. The exceptions are raised when the code calls the <see cref="M:System.IO.Pipes.PipeStream.EndRead(System.IAsyncResult)" /> method.</para>
  350. </remarks>
  351. <summary>
  352. <attribution license="cc4" from="Microsoft" modified="false" />
  353. <para>Ends a pending asynchronous read request.</para>
  354. </summary>
  355. <returns>
  356. <attribution license="cc4" from="Microsoft" modified="false" />
  357. <para>The number of bytes that were read. A return value of 0 indicates the end of the stream (the pipe has been closed).</para>
  358. </returns>
  359. <param name="asyncResult">
  360. <attribution license="cc4" from="Microsoft" modified="false" />The reference to the pending asynchronous request.</param>
  361. </Docs>
  362. </Member>
  363. <Member MemberName="EndWrite">
  364. <MemberSignature Language="C#" Value="public override void EndWrite (IAsyncResult asyncResult);" />
  365. <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance void EndWrite(class System.IAsyncResult asyncResult) cil managed" />
  366. <MemberType>Method</MemberType>
  367. <AssemblyInfo>
  368. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  369. </AssemblyInfo>
  370. <ReturnValue>
  371. <ReturnType>System.Void</ReturnType>
  372. </ReturnValue>
  373. <Parameters>
  374. <Parameter Name="asyncResult" Type="System.IAsyncResult" />
  375. </Parameters>
  376. <Docs>
  377. <remarks>
  378. <attribution license="cc4" from="Microsoft" modified="false" />
  379. <para>
  380. <see cref="M:System.IO.Pipes.PipeStream.EndWrite(System.IAsyncResult)" /> must be called once for every call to <see cref="M:System.IO.Pipes.PipeStream.BeginWrite(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object)" />. This can be done either in the same code that called <see cref="M:System.IO.Pipes.PipeStream.BeginWrite(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object)" /> or in a callback that is passed to <see cref="M:System.IO.Pipes.PipeStream.BeginWrite(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object)" />.</para>
  381. <para>Use the <see cref="P:System.IO.Pipes.PipeStream.CanWrite" /> property to determine whether the current <see cref="T:System.IO.Pipes.PipeStream" /> object supports write operations.</para>
  382. <para>If the pipe is closed or an invalid argument is passed to <see cref="M:System.IO.Pipes.PipeStream.BeginWrite(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object)" />, the appropriate exceptions are raised immediately. Errors that occur during an asynchronous write request occur on the thread pool thread that is performing the request. The exceptions are raised when the code the calls <see cref="M:System.IO.Pipes.PipeStream.EndWrite(System.IAsyncResult)" /> method.</para>
  383. </remarks>
  384. <summary>
  385. <attribution license="cc4" from="Microsoft" modified="false" />
  386. <para>Ends a pending asynchronous write request.</para>
  387. </summary>
  388. <param name="asyncResult">
  389. <attribution license="cc4" from="Microsoft" modified="false" />The reference to the pending asynchronous request.</param>
  390. </Docs>
  391. </Member>
  392. <Member MemberName="Flush">
  393. <MemberSignature Language="C#" Value="public override void Flush ();" />
  394. <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance void Flush() cil managed" />
  395. <MemberType>Method</MemberType>
  396. <AssemblyInfo>
  397. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  398. </AssemblyInfo>
  399. <Attributes>
  400. <Attribute>
  401. <AttributeName>System.MonoTODO</AttributeName>
  402. </Attribute>
  403. </Attributes>
  404. <ReturnValue>
  405. <ReturnType>System.Void</ReturnType>
  406. </ReturnValue>
  407. <Parameters />
  408. <Docs>
  409. <remarks>
  410. <attribution license="cc4" from="Microsoft" modified="false" />
  411. <para>The <see cref="M:System.IO.Pipes.PipeStream.Flush" /> method is not supported in the <see cref="T:System.IO.Pipes.PipeStream" /> class and does nothing when it is called.</para>
  412. </remarks>
  413. <summary>
  414. <attribution license="cc4" from="Microsoft" modified="false" />
  415. <para>Clears the buffer for the current stream and causes any buffered data to be written to the underlying device.</para>
  416. </summary>
  417. </Docs>
  418. </Member>
  419. <Member MemberName="GetAccessControl">
  420. <MemberSignature Language="C#" Value="public System.IO.Pipes.PipeSecurity GetAccessControl ();" />
  421. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.IO.Pipes.PipeSecurity GetAccessControl() cil managed" />
  422. <MemberType>Method</MemberType>
  423. <AssemblyInfo>
  424. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  425. </AssemblyInfo>
  426. <ReturnValue>
  427. <ReturnType>System.IO.Pipes.PipeSecurity</ReturnType>
  428. </ReturnValue>
  429. <Parameters />
  430. <Docs>
  431. <remarks>
  432. <attribution license="cc4" from="Microsoft" modified="false" />
  433. <para>An access control list (ACL) describes individuals and/or groups that have, or do not have, rights to perform specific actions on a specified file. For more information, see <format type="text/html"><a href="06fbf66d-6f02-4378-b863-b2f12e349045">ACL Technology Overview</a></format> and <format type="text/html"><a href="53758b39-bd9b-4640-bb04-cad5ed8d0abf">How To: Add or Remove Access Control List Entries</a></format>.</para>
  434. </remarks>
  435. <summary>
  436. <attribution license="cc4" from="Microsoft" modified="false" />
  437. <para>Gets a <see cref="T:System.IO.Pipes.PipeSecurity" /> object that encapsulates the access control list (ACL) entries for the pipe described by the current <see cref="T:System.IO.Pipes.PipeStream" /> object.</para>
  438. </summary>
  439. <returns>
  440. <attribution license="cc4" from="Microsoft" modified="false" />
  441. <para>A <see cref="T:System.IO.Pipes.PipeSecurity" /> object that encapsulates the access control list (ACL) entries for the pipe described by the current <see cref="T:System.IO.Pipes.PipeStream" /> object.</para>
  442. </returns>
  443. </Docs>
  444. </Member>
  445. <Member MemberName="InBufferSize">
  446. <MemberSignature Language="C#" Value="public virtual int InBufferSize { get; }" />
  447. <MemberSignature Language="ILAsm" Value=".property instance int32 InBufferSize" />
  448. <MemberType>Property</MemberType>
  449. <AssemblyInfo>
  450. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  451. </AssemblyInfo>
  452. <ReturnValue>
  453. <ReturnType>System.Int32</ReturnType>
  454. </ReturnValue>
  455. <Docs>
  456. <value>To be added.</value>
  457. <remarks>
  458. <attribution license="cc4" from="Microsoft" modified="false" />
  459. <para>If <see cref="P:System.IO.Pipes.PipeStream.InBufferSize" /> is 0, the buffer size is allocated as needed.</para>
  460. </remarks>
  461. <summary>
  462. <attribution license="cc4" from="Microsoft" modified="false" />
  463. <para>Gets the size, in bytes, of the inbound buffer for a pipe.</para>
  464. </summary>
  465. </Docs>
  466. </Member>
  467. <Member MemberName="InitializeHandle">
  468. <MemberSignature Language="C#" Value="protected void InitializeHandle (Microsoft.Win32.SafeHandles.SafePipeHandle handle, bool isExposed, bool isAsync);" />
  469. <MemberSignature Language="ILAsm" Value=".method familyhidebysig instance void InitializeHandle(class Microsoft.Win32.SafeHandles.SafePipeHandle handle, bool isExposed, bool isAsync) cil managed" />
  470. <MemberType>Method</MemberType>
  471. <AssemblyInfo>
  472. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  473. </AssemblyInfo>
  474. <ReturnValue>
  475. <ReturnType>System.Void</ReturnType>
  476. </ReturnValue>
  477. <Parameters>
  478. <Parameter Name="handle" Type="Microsoft.Win32.SafeHandles.SafePipeHandle" />
  479. <Parameter Name="isExposed" Type="System.Boolean" />
  480. <Parameter Name="isAsync" Type="System.Boolean" />
  481. </Parameters>
  482. <Docs>
  483. <remarks>
  484. <attribution license="cc4" from="Microsoft" modified="false" />
  485. <para>If the pipe is in a connected state, this method also sets the <see cref="P:System.IO.Pipes.PipeStream.IsConnected" /> property to true.</para>
  486. </remarks>
  487. <summary>
  488. <attribution license="cc4" from="Microsoft" modified="false" />
  489. <para>Initializes a <see cref="T:System.IO.Pipes.PipeStream" /> object from the specified <see cref="T:Microsoft.Win32.SafeHandles.SafePipeHandle" /> object.</para>
  490. </summary>
  491. <param name="handle">
  492. <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:Microsoft.Win32.SafeHandles.SafePipeHandle" /> object of the pipe to initialize.</param>
  493. <param name="isExposed">
  494. <attribution license="cc4" from="Microsoft" modified="false" />true to expose the handle; otherwise, false.</param>
  495. <param name="isAsync">
  496. <attribution license="cc4" from="Microsoft" modified="false" />true to indicate that the handle was opened asynchronously; otherwise, false.</param>
  497. </Docs>
  498. </Member>
  499. <Member MemberName="IsAsync">
  500. <MemberSignature Language="C#" Value="public bool IsAsync { get; }" />
  501. <MemberSignature Language="ILAsm" Value=".property instance bool IsAsync" />
  502. <MemberType>Property</MemberType>
  503. <AssemblyInfo>
  504. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  505. </AssemblyInfo>
  506. <ReturnValue>
  507. <ReturnType>System.Boolean</ReturnType>
  508. </ReturnValue>
  509. <Docs>
  510. <value>To be added.</value>
  511. <remarks>
  512. <attribution license="cc4" from="Microsoft" modified="false" />
  513. <para>This property enables your code to use the <see cref="P:System.IO.Pipes.PipeStream.SafePipeHandle" /> property correctly.</para>
  514. </remarks>
  515. <summary>
  516. <attribution license="cc4" from="Microsoft" modified="false" />
  517. <para>Gets a value indicating whether a <see cref="T:System.IO.Pipes.PipeStream" /> object was opened asynchronously or synchronously.</para>
  518. </summary>
  519. </Docs>
  520. </Member>
  521. <Member MemberName="IsConnected">
  522. <MemberSignature Language="C#" Value="public bool IsConnected { get; protected set; }" />
  523. <MemberSignature Language="ILAsm" Value=".property instance bool IsConnected" />
  524. <MemberType>Property</MemberType>
  525. <AssemblyInfo>
  526. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  527. </AssemblyInfo>
  528. <ReturnValue>
  529. <ReturnType>System.Boolean</ReturnType>
  530. </ReturnValue>
  531. <Docs>
  532. <value>To be added.</value>
  533. <remarks>
  534. <attribution license="cc4" from="Microsoft" modified="false" />
  535. <para>The <see cref="P:System.IO.Pipes.PipeStream.IsConnected" /> property returns true only if the <see cref="T:System.IO.Pipes.PipeStream" /> object is connected. If this property returns false, the pipe may be waiting to connect, or may be disconnected, closed, or broken.</para>
  536. </remarks>
  537. <summary>
  538. <attribution license="cc4" from="Microsoft" modified="false" />
  539. <para>Gets or sets a value indicating whether a <see cref="T:System.IO.Pipes.PipeStream" /> object is connected.</para>
  540. </summary>
  541. </Docs>
  542. </Member>
  543. <Member MemberName="IsHandleExposed">
  544. <MemberSignature Language="C#" Value="protected bool IsHandleExposed { get; }" />
  545. <MemberSignature Language="ILAsm" Value=".property instance bool IsHandleExposed" />
  546. <MemberType>Property</MemberType>
  547. <AssemblyInfo>
  548. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  549. </AssemblyInfo>
  550. <ReturnValue>
  551. <ReturnType>System.Boolean</ReturnType>
  552. </ReturnValue>
  553. <Docs>
  554. <value>To be added.</value>
  555. <remarks>
  556. <attribution license="cc4" from="Microsoft" modified="false" />
  557. <para>The value of this property is set when obtaining a handle to the pipe that is encapsulated by the current <see cref="T:System.IO.Pipes.PipeStream" /> object.</para>
  558. </remarks>
  559. <summary>
  560. <attribution license="cc4" from="Microsoft" modified="false" />
  561. <para>Gets a value indicating whether a handle to a <see cref="T:System.IO.Pipes.PipeStream" /> object is exposed.</para>
  562. </summary>
  563. </Docs>
  564. </Member>
  565. <Member MemberName="IsMessageComplete">
  566. <MemberSignature Language="C#" Value="public bool IsMessageComplete { get; }" />
  567. <MemberSignature Language="ILAsm" Value=".property instance bool IsMessageComplete" />
  568. <MemberType>Property</MemberType>
  569. <AssemblyInfo>
  570. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  571. </AssemblyInfo>
  572. <Attributes>
  573. <Attribute>
  574. <AttributeName>System.MonoTODO</AttributeName>
  575. </Attribute>
  576. </Attributes>
  577. <ReturnValue>
  578. <ReturnType>System.Boolean</ReturnType>
  579. </ReturnValue>
  580. <Docs>
  581. <value>To be added.</value>
  582. <remarks>
  583. <attribution license="cc4" from="Microsoft" modified="false" />
  584. <para>This property is relevant if the pipe's <see cref="P:System.IO.Pipes.PipeStream.ReadMode" /> property was set to <see cref="F:System.IO.Pipes.PipeTransmissionMode.Message" /> by the most recent call to <see cref="M:System.IO.Pipes.PipeStream.Read(System.Byte[],System.Int32,System.Int32)" /> or <see cref="M:System.IO.Pipes.PipeStream.EndRead(System.IAsyncResult)" />.</para>
  585. </remarks>
  586. <summary>
  587. <attribution license="cc4" from="Microsoft" modified="false" />
  588. <para>Gets a value indicating whether there is more data in the message returned from the most recent read operation.</para>
  589. </summary>
  590. </Docs>
  591. </Member>
  592. <Member MemberName="Length">
  593. <MemberSignature Language="C#" Value="public override long Length { get; }" />
  594. <MemberSignature Language="ILAsm" Value=".property instance int64 Length" />
  595. <MemberType>Property</MemberType>
  596. <AssemblyInfo>
  597. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  598. </AssemblyInfo>
  599. <ReturnValue>
  600. <ReturnType>System.Int64</ReturnType>
  601. </ReturnValue>
  602. <Docs>
  603. <value>To be added.</value>
  604. <remarks>
  605. <attribution license="cc4" from="Microsoft" modified="false" />
  606. <para>The <see cref="T:System.IO.Pipes.PipeStream" /> class does not support the <see cref="P:System.IO.Pipes.PipeStream.Length" /> property.</para>
  607. </remarks>
  608. <summary>
  609. <attribution license="cc4" from="Microsoft" modified="false" />
  610. <para>Gets the length of a stream, in bytes.</para>
  611. </summary>
  612. </Docs>
  613. </Member>
  614. <Member MemberName="OutBufferSize">
  615. <MemberSignature Language="C#" Value="public virtual int OutBufferSize { get; }" />
  616. <MemberSignature Language="ILAsm" Value=".property instance int32 OutBufferSize" />
  617. <MemberType>Property</MemberType>
  618. <AssemblyInfo>
  619. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  620. </AssemblyInfo>
  621. <Attributes>
  622. <Attribute>
  623. <AttributeName>System.MonoTODO</AttributeName>
  624. </Attribute>
  625. </Attributes>
  626. <ReturnValue>
  627. <ReturnType>System.Int32</ReturnType>
  628. </ReturnValue>
  629. <Docs>
  630. <value>To be added.</value>
  631. <remarks>
  632. <attribution license="cc4" from="Microsoft" modified="false" />
  633. <para>If <see cref="P:System.IO.Pipes.PipeStream.OutBufferSize" /> is 0, the buffer size is allocated as needed.</para>
  634. </remarks>
  635. <summary>
  636. <attribution license="cc4" from="Microsoft" modified="false" />
  637. <para>Gets the size, in bytes, of the outbound buffer for a pipe.</para>
  638. </summary>
  639. </Docs>
  640. </Member>
  641. <Member MemberName="Position">
  642. <MemberSignature Language="C#" Value="public override long Position { get; set; }" />
  643. <MemberSignature Language="ILAsm" Value=".property instance int64 Position" />
  644. <MemberType>Property</MemberType>
  645. <AssemblyInfo>
  646. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  647. </AssemblyInfo>
  648. <ReturnValue>
  649. <ReturnType>System.Int64</ReturnType>
  650. </ReturnValue>
  651. <Docs>
  652. <value>To be added.</value>
  653. <remarks>
  654. <attribution license="cc4" from="Microsoft" modified="false" />
  655. <para>The <see cref="T:System.IO.Pipes.PipeStream" /> class does not support the <see cref="P:System.IO.Pipes.PipeStream.Position" /> property.</para>
  656. </remarks>
  657. <summary>
  658. <attribution license="cc4" from="Microsoft" modified="false" />
  659. <para>Gets or sets the current position of the current stream.</para>
  660. </summary>
  661. </Docs>
  662. </Member>
  663. <Member MemberName="Read">
  664. <MemberSignature Language="C#" Value="public override int Read (byte[] buffer, int offset, int count);" />
  665. <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance int32 Read(unsigned int8[] buffer, int32 offset, int32 count) cil managed" />
  666. <MemberType>Method</MemberType>
  667. <AssemblyInfo>
  668. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  669. </AssemblyInfo>
  670. <Attributes>
  671. <Attribute>
  672. <AttributeName>System.MonoTODO</AttributeName>
  673. </Attribute>
  674. </Attributes>
  675. <ReturnValue>
  676. <ReturnType>System.Int32</ReturnType>
  677. </ReturnValue>
  678. <Parameters>
  679. <Parameter Name="buffer" Type="System.Byte[]" />
  680. <Parameter Name="offset" Type="System.Int32" />
  681. <Parameter Name="count" Type="System.Int32" />
  682. </Parameters>
  683. <Docs>
  684. <remarks>
  685. <attribution license="cc4" from="Microsoft" modified="false" />
  686. <para>Use the <see cref="P:System.IO.Pipes.PipeStream.CanRead" /> property to determine whether the current <see cref="T:System.IO.Pipes.PipeStream" /> object supports read operations.</para>
  687. <para>Calling the <see cref="M:System.IO.Pipes.PipeStream.Read(System.Byte[],System.Int32,System.Int32)" /> method blocks until <paramref name="count" /> bytes are read or the end of the stream is reached. For asynchronous read operations, see <see cref="M:System.IO.Pipes.PipeStream.BeginRead(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object)" /> and <see cref="M:System.IO.Pipes.PipeStream.EndRead(System.IAsyncResult)" />.</para>
  688. </remarks>
  689. <summary>
  690. <attribution license="cc4" from="Microsoft" modified="false" />
  691. <para>Reads a block of bytes from a stream and writes the data to a specified buffer.</para>
  692. </summary>
  693. <returns>
  694. <attribution license="cc4" from="Microsoft" modified="false" />
  695. <para>The total number of bytes that are read into <paramref name="buffer" />. This might be less than the number of bytes requested if that number of bytes is not currently available, or 0 if the end of the stream is reached.</para>
  696. </returns>
  697. <param name="buffer">
  698. <attribution license="cc4" from="Microsoft" modified="false" />When this method returns, contains the specified byte array with the values between <paramref name="offset" /> and (<paramref name="offset" /> + <paramref name="count" /> - 1) replaced by the bytes read from the current source.</param>
  699. <param name="offset">
  700. <attribution license="cc4" from="Microsoft" modified="false" />The byte offset in the <paramref name="buffer" /> array at which the bytes that are read will be placed.</param>
  701. <param name="count">
  702. <attribution license="cc4" from="Microsoft" modified="false" />The maximum number of bytes to read.</param>
  703. </Docs>
  704. </Member>
  705. <Member MemberName="ReadByte">
  706. <MemberSignature Language="C#" Value="public override int ReadByte ();" />
  707. <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance int32 ReadByte() cil managed" />
  708. <MemberType>Method</MemberType>
  709. <AssemblyInfo>
  710. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  711. </AssemblyInfo>
  712. <Attributes>
  713. <Attribute>
  714. <AttributeName>System.MonoTODO</AttributeName>
  715. </Attribute>
  716. </Attributes>
  717. <ReturnValue>
  718. <ReturnType>System.Int32</ReturnType>
  719. </ReturnValue>
  720. <Parameters />
  721. <Docs>
  722. <remarks>
  723. <attribution license="cc4" from="Microsoft" modified="false" />
  724. <para>Use the <see cref="P:System.IO.Pipes.PipeStream.CanRead" /> property to determine whether the current <see cref="T:System.IO.Pipes.PipeStream" /> object supports read operations.</para>
  725. </remarks>
  726. <summary>
  727. <attribution license="cc4" from="Microsoft" modified="false" />
  728. <para>Reads a byte from a pipe.</para>
  729. </summary>
  730. <returns>
  731. <attribution license="cc4" from="Microsoft" modified="false" />
  732. <para>The byte, cast to <see cref="T:System.Int32" />, or -1 indicates the end of the stream (the pipe has been closed).</para>
  733. </returns>
  734. </Docs>
  735. </Member>
  736. <Member MemberName="ReadMode">
  737. <MemberSignature Language="C#" Value="public virtual System.IO.Pipes.PipeTransmissionMode ReadMode { get; set; }" />
  738. <MemberSignature Language="ILAsm" Value=".property instance valuetype System.IO.Pipes.PipeTransmissionMode ReadMode" />
  739. <MemberType>Property</MemberType>
  740. <AssemblyInfo>
  741. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  742. </AssemblyInfo>
  743. <ReturnValue>
  744. <ReturnType>System.IO.Pipes.PipeTransmissionMode</ReturnType>
  745. </ReturnValue>
  746. <Docs>
  747. <value>To be added.</value>
  748. <remarks>
  749. <attribution license="cc4" from="Microsoft" modified="false" />
  750. <para>Anonymous pipes do not support <see cref="F:System.IO.Pipes.PipeTransmissionMode.Message" /> mode message transmission.</para>
  751. </remarks>
  752. <summary>
  753. <attribution license="cc4" from="Microsoft" modified="false" />
  754. <para>Gets or sets the reading mode for a <see cref="T:System.IO.Pipes.PipeStream" /> object.</para>
  755. </summary>
  756. </Docs>
  757. </Member>
  758. <Member MemberName="SafePipeHandle">
  759. <MemberSignature Language="C#" Value="public Microsoft.Win32.SafeHandles.SafePipeHandle SafePipeHandle { get; }" />
  760. <MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Win32.SafeHandles.SafePipeHandle SafePipeHandle" />
  761. <MemberType>Property</MemberType>
  762. <AssemblyInfo>
  763. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  764. </AssemblyInfo>
  765. <ReturnValue>
  766. <ReturnType>Microsoft.Win32.SafeHandles.SafePipeHandle</ReturnType>
  767. </ReturnValue>
  768. <Docs>
  769. <value>To be added.</value>
  770. <remarks>To be added.</remarks>
  771. <summary>
  772. <attribution license="cc4" from="Microsoft" modified="false" />
  773. <para>Gets the safe handle for the local end of the pipe that the current <see cref="T:System.IO.Pipes.PipeStream" /> object encapsulates.</para>
  774. </summary>
  775. </Docs>
  776. </Member>
  777. <Member MemberName="Seek">
  778. <MemberSignature Language="C#" Value="public override long Seek (long offset, System.IO.SeekOrigin origin);" />
  779. <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance int64 Seek(int64 offset, valuetype System.IO.SeekOrigin origin) cil managed" />
  780. <MemberType>Method</MemberType>
  781. <AssemblyInfo>
  782. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  783. </AssemblyInfo>
  784. <ReturnValue>
  785. <ReturnType>System.Int64</ReturnType>
  786. </ReturnValue>
  787. <Parameters>
  788. <Parameter Name="offset" Type="System.Int64" />
  789. <Parameter Name="origin" Type="System.IO.SeekOrigin" />
  790. </Parameters>
  791. <Docs>
  792. <remarks>
  793. <attribution license="cc4" from="Microsoft" modified="false" />
  794. <para>The <see cref="M:System.IO.Pipes.PipeStream.Seek(System.Int64,System.IO.SeekOrigin)" /> method is not supported in pipes and raises a <see cref="T:System.NotSupportedException" /> when it is called.</para>
  795. </remarks>
  796. <summary>
  797. <attribution license="cc4" from="Microsoft" modified="false" />
  798. <para>Sets the current position of the current stream to the specified value.</para>
  799. </summary>
  800. <returns>
  801. <attribution license="cc4" from="Microsoft" modified="false" />
  802. <para>The new position in the stream.</para>
  803. </returns>
  804. <param name="offset">
  805. <attribution license="cc4" from="Microsoft" modified="false" />The point, relative to <paramref name="origin" />, to begin seeking from.</param>
  806. <param name="origin">
  807. <attribution license="cc4" from="Microsoft" modified="false" />Specifies the beginning, the end, or the current position as a reference point for <paramref name="offset" />, using a value of type <see cref="T:System.IO.SeekOrigin" />.</param>
  808. </Docs>
  809. </Member>
  810. <Member MemberName="SetAccessControl">
  811. <MemberSignature Language="C#" Value="public void SetAccessControl (System.IO.Pipes.PipeSecurity pipeSecurity);" />
  812. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SetAccessControl(class System.IO.Pipes.PipeSecurity pipeSecurity) cil managed" />
  813. <MemberType>Method</MemberType>
  814. <AssemblyInfo>
  815. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  816. </AssemblyInfo>
  817. <ReturnValue>
  818. <ReturnType>System.Void</ReturnType>
  819. </ReturnValue>
  820. <Parameters>
  821. <Parameter Name="pipeSecurity" Type="System.IO.Pipes.PipeSecurity" />
  822. </Parameters>
  823. <Docs>
  824. <remarks>
  825. <attribution license="cc4" from="Microsoft" modified="false" />
  826. <para>An access control list (ACL) describes individuals and/or groups that have, or do not have, rights to perform specific actions on a specified file. For more information, see <format type="text/html"><a href="06fbf66d-6f02-4378-b863-b2f12e349045">ACL Technology Overview</a></format> and <format type="text/html"><a href="53758b39-bd9b-4640-bb04-cad5ed8d0abf">How To: Add or Remove Access Control List Entries</a></format>.</para>
  827. </remarks>
  828. <summary>
  829. <attribution license="cc4" from="Microsoft" modified="false" />
  830. <para>Applies the access control list (ACL) entries specified by a <see cref="T:System.IO.Pipes.PipeSecurity" /> object to the pipe specified by the current <see cref="T:System.IO.Pipes.PipeStream" /> object.</para>
  831. </summary>
  832. <param name="pipeSecurity">
  833. <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.IO.Pipes.PipeSecurity" /> object that specifies an access control list (ACL) entry to apply to the current pipe.</param>
  834. </Docs>
  835. </Member>
  836. <Member MemberName="SetLength">
  837. <MemberSignature Language="C#" Value="public override void SetLength (long value);" />
  838. <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance void SetLength(int64 value) cil managed" />
  839. <MemberType>Method</MemberType>
  840. <AssemblyInfo>
  841. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  842. </AssemblyInfo>
  843. <ReturnValue>
  844. <ReturnType>System.Void</ReturnType>
  845. </ReturnValue>
  846. <Parameters>
  847. <Parameter Name="value" Type="System.Int64" />
  848. </Parameters>
  849. <Docs>
  850. <remarks>
  851. <attribution license="cc4" from="Microsoft" modified="false" />
  852. <para>The <see cref="T:System.IO.Pipes.PipeStream" /> class does not support the <see cref="M:System.IO.Pipes.PipeStream.SetLength(System.Int64)" /> method.</para>
  853. </remarks>
  854. <summary>
  855. <attribution license="cc4" from="Microsoft" modified="false" />
  856. <para>Sets the length of the current stream to the specified value.</para>
  857. </summary>
  858. <param name="value">
  859. <attribution license="cc4" from="Microsoft" modified="false" />The new length of the stream.</param>
  860. </Docs>
  861. </Member>
  862. <Member MemberName="TransmissionMode">
  863. <MemberSignature Language="C#" Value="public virtual System.IO.Pipes.PipeTransmissionMode TransmissionMode { get; }" />
  864. <MemberSignature Language="ILAsm" Value=".property instance valuetype System.IO.Pipes.PipeTransmissionMode TransmissionMode" />
  865. <MemberType>Property</MemberType>
  866. <AssemblyInfo>
  867. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  868. </AssemblyInfo>
  869. <ReturnValue>
  870. <ReturnType>System.IO.Pipes.PipeTransmissionMode</ReturnType>
  871. </ReturnValue>
  872. <Docs>
  873. <value>To be added.</value>
  874. <remarks>
  875. <attribution license="cc4" from="Microsoft" modified="false" />
  876. <para>Anonymous pipes do not support <see cref="F:System.IO.Pipes.PipeTransmissionMode.Message" /> mode message transmission.</para>
  877. </remarks>
  878. <summary>
  879. <attribution license="cc4" from="Microsoft" modified="false" />
  880. <para>Gets the pipe transmission mode supported by the current pipe.</para>
  881. </summary>
  882. </Docs>
  883. </Member>
  884. <Member MemberName="WaitForPipeDrain">
  885. <MemberSignature Language="C#" Value="public void WaitForPipeDrain ();" />
  886. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void WaitForPipeDrain() cil managed" />
  887. <MemberType>Method</MemberType>
  888. <AssemblyInfo>
  889. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  890. </AssemblyInfo>
  891. <ReturnValue>
  892. <ReturnType>System.Void</ReturnType>
  893. </ReturnValue>
  894. <Parameters />
  895. <Docs>
  896. <remarks>
  897. <attribution license="cc4" from="Microsoft" modified="false" />
  898. <para>The <see cref="M:System.IO.Pipes.PipeStream.WaitForPipeDrain" /> method blocks until the other end of the pipe has read all sent bytes.</para>
  899. </remarks>
  900. <summary>
  901. <attribution license="cc4" from="Microsoft" modified="false" />
  902. <para>Waits for the other end of the pipe to read all sent bytes.</para>
  903. </summary>
  904. </Docs>
  905. </Member>
  906. <Member MemberName="Write">
  907. <MemberSignature Language="C#" Value="public override void Write (byte[] buffer, int offset, int count);" />
  908. <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance void Write(unsigned int8[] buffer, int32 offset, int32 count) cil managed" />
  909. <MemberType>Method</MemberType>
  910. <AssemblyInfo>
  911. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  912. </AssemblyInfo>
  913. <Attributes>
  914. <Attribute>
  915. <AttributeName>System.MonoTODO</AttributeName>
  916. </Attribute>
  917. </Attributes>
  918. <ReturnValue>
  919. <ReturnType>System.Void</ReturnType>
  920. </ReturnValue>
  921. <Parameters>
  922. <Parameter Name="buffer" Type="System.Byte[]" />
  923. <Parameter Name="offset" Type="System.Int32" />
  924. <Parameter Name="count" Type="System.Int32" />
  925. </Parameters>
  926. <Docs>
  927. <remarks>
  928. <attribution license="cc4" from="Microsoft" modified="false" />
  929. <para>Use the <see cref="P:System.IO.Pipes.PipeStream.CanWrite" /> property to determine whether the current <see cref="T:System.IO.Pipes.PipeStream" /> object supports write operations.</para>
  930. <para>Calling the <see cref="M:System.IO.Pipes.PipeStream.Write(System.Byte[],System.Int32,System.Int32)" /> method blocks until <paramref name="count" /> bytes are read or the end of the stream is reached. For asynchronous read operations, see <see cref="M:System.IO.Pipes.PipeStream.BeginWrite(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object)" /> and <see cref="M:System.IO.Pipes.PipeStream.EndWrite(System.IAsyncResult)" />.</para>
  931. </remarks>
  932. <summary>
  933. <attribution license="cc4" from="Microsoft" modified="false" />
  934. <para>Writes a block of bytes to the current stream using data from a buffer.</para>
  935. </summary>
  936. <param name="buffer">
  937. <attribution license="cc4" from="Microsoft" modified="false" />The buffer that contains data to write to the pipe.</param>
  938. <param name="offset">
  939. <attribution license="cc4" from="Microsoft" modified="false" />The zero-based byte offset in <paramref name="buffer" /> at which to begin copying bytes to the current stream.</param>
  940. <param name="count">
  941. <attribution license="cc4" from="Microsoft" modified="false" />The maximum number of bytes to write to the current stream.</param>
  942. </Docs>
  943. </Member>
  944. <Member MemberName="WriteByte">
  945. <MemberSignature Language="C#" Value="public override void WriteByte (byte value);" />
  946. <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance void WriteByte(unsigned int8 value) cil managed" />
  947. <MemberType>Method</MemberType>
  948. <AssemblyInfo>
  949. <AssemblyVersion>4.0.0.0</AssemblyVersion>
  950. </AssemblyInfo>
  951. <Attributes>
  952. <Attribute>
  953. <AttributeName>System.MonoTODO</AttributeName>
  954. </Attribute>
  955. </Attributes>
  956. <ReturnValue>
  957. <ReturnType>System.Void</ReturnType>
  958. </ReturnValue>
  959. <Parameters>
  960. <Parameter Name="value" Type="System.Byte" />
  961. </Parameters>
  962. <Docs>
  963. <remarks>
  964. <attribution license="cc4" from="Microsoft" modified="false" />
  965. <para>Use the <see cref="P:System.IO.Pipes.PipeStream.CanWrite" /> property to determine whether the current <see cref="T:System.IO.Pipes.PipeStream" /> object supports write operations.</para>
  966. </remarks>
  967. <summary>
  968. <attribution license="cc4" from="Microsoft" modified="false" />
  969. <para>Writes a byte to the current stream.</para>
  970. </summary>
  971. <param name="value">
  972. <attribution license="cc4" from="Microsoft" modified="false" />The byte to write to the stream.</param>
  973. </Docs>
  974. </Member>
  975. </Members>
  976. </Type>