You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<paramname="buffer">A region of memory. When this method returns, the contents of this region are replaced by the bytes read from the current source.</param>
1275
+
<summary>Reads a sequence of bytes from the current stream, writes them to a byte array, and advances the position within the stream by the number of bytes read.</summary>
1276
+
<returns>The total number of bytes read into the <paramrefname="buffer" />. This can be less than the number of bytes allocated in <paramrefname="buffer" /> if that many bytes are not currently available, or zero (0) if the end of the stream has been reached.</returns>
1277
+
<remarks>
1278
+
<formattype="text/markdown"><![CDATA[
1279
+
1280
+
## Remarks
1281
+
1282
+
Use the <xref:System.IO.Pipes.PipeStream.CanRead%2A> property to determine whether the current <xref:System.IO.Pipes.PipeStream> object supports read operations.
1283
+
1284
+
Use the <xref:System.IO.Pipes.PipeStream.ReadAsync%2A> method to read asynchronously from the current stream.
1285
+
1286
+
This method reads a maximum of `buffer.Length` bytes from the current stream and stores them in `buffer`. The current position within the stream is advanced by the number of bytes read; however, if an exception occurs, the current position within the stream remains unchanged.
1287
+
1288
+
This method will block until at least one byte of data can be read, in the event that no data is available.
1289
+
1290
+
This method returns 0 only when there is no more data in the stream and no more is expected (such as a closed socket or end of file).
1291
+
1292
+
This method is free to return fewer bytes than requested even if the end of the stream has not been reached.
1293
+
1294
+
Use `BinaryReader` for reading primitive data types.
1295
+
1296
+
]]></format>
1297
+
</remarks>
1298
+
<exceptioncref="T:System.ArgumentNullException">The number of bytes read was longer than the buffer length.</exception>
1299
+
<exceptioncref="T:System.NotSupportedException">The stream does not support reading.</exception>
1300
+
<exceptioncref="T:System.ObjectDisposedException">Cannot access a closed pipe.</exception>
The pipe handle has not been set. (Did your <seecref="T:System.IO.Pipes.PipeStream" /> implementation call <seecref="T:System.IO.Pipes.PipeStream.InitializeHandle(Microsoft.Win32.SafeHandles.SafePipeHandle,System.Boolean,System.Boolean)" />?
1311
+
</exception>
1278
1312
</Docs>
1279
1313
</Member>
1280
1314
<MemberMemberName="Read">
@@ -1319,7 +1353,7 @@
1319
1353
<paramname="buffer">When this method returns, contains the specified byte array with the values between <paramrefname="offset" /> and (<paramrefname="offset" /> + <paramrefname="count" /> - 1) replaced by the bytes read from the current source.</param>
1320
1354
<paramname="offset">The byte offset in the <paramrefname="buffer" /> array at which the bytes that are read will be placed.</param>
1321
1355
<paramname="count">The maximum number of bytes to read.</param>
1322
-
<summary>Reads a block of bytes from a stream and writes the data to a specified buffer.</summary>
1356
+
<summary>Reads a block of bytes from a stream and writes the data to a specified buffer starting at a specified position for a specified length.</summary>
1323
1357
<returns>The total number of bytes that are read into <paramrefname="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.</returns>
<paramname="cancellationToken">To be added.</param>
1385
-
<summary>To be added.</summary>
1386
-
<returns>To be added.</returns>
1387
-
<remarks>To be added.</remarks>
1417
+
<paramname="buffer">The region of memory to write the data into.</param>
1418
+
<paramname="cancellationToken">The token to monitor for cancellation requests. The default value is <seecref="P:System.Threading.CancellationToken.None" />.</param>
1419
+
<summary>Asynchronously reads a sequence of bytes from the current stream, writes them to a byte memory range, advances the position within the stream by the number of bytes read, and monitors cancellation requests.</summary>
1420
+
<returns>A task that represents the asynchronous read operation. The value of its <seecref="P:System.Threading.Tasks.ValueTask`1.Result" /> property contains the total number of bytes read into the buffer. The result value can be less than the number of bytes allocated in the buffer if that many bytes are not currently available, or it can be 0 (zero) if the end of the stream has been reached.</returns>
1421
+
<remarks>
1422
+
<formattype="text/markdown"><] app or [!INCLUDE[desktop_appname](~/includes/desktop-appname-md.md)] app where a time-consuming stream operation can block the UI thread and make your app appear as if it is not working. The async methods are used in conjunction with the `async` and `await` keywords in Visual Basic and C#.
1427
+
1428
+
Use the <xref:System.IO.Pipes.PipeStream.CanRead%2A> property to determine whether the current instance supports reading.
1429
+
1430
+
If the operation is canceled before it completes, the returned task contains the <xref:System.Threading.Tasks.TaskStatus.Canceled?displayProperty=nameWithType> value for the <xref:System.Threading.Tasks.Task.Status> property.
1431
+
1432
+
]]></format>
1433
+
</remarks>
1434
+
<exceptioncref="T:System.NotSupportedException">The stream does not support reading.</exception>
1435
+
<exceptioncref="T:System.ObjectDisposedException">Cannot access a closed pipe.</exception>
The pipe handle has not been set. (Did your <seecref="T:System.IO.Pipes.PipeStream" /> implementation call <seecref="T:System.IO.Pipes.PipeStream.InitializeHandle(Microsoft.Win32.SafeHandles.SafePipeHandle,System.Boolean,System.Boolean)" />?
<paramname="cancellationToken">To be added.</param>
1424
-
<summary>To be added.</summary>
1425
-
<returns>To be added.</returns>
1426
-
<remarks>To be added.</remarks>
1479
+
<paramname="buffer">The buffer to write the data into.</param>
1480
+
<paramname="offset">The byte offset in <paramrefname="buffer" /> at which to begin writing data from the stream.</param>
1481
+
<paramname="count">The maximum number of bytes to read.</param>
1482
+
<paramname="cancellationToken">The token to monitor for cancellation requests. The default value is <seecref="P:System.Threading.CancellationToken.None" />.</param>
1483
+
<summary>Asynchronously reads a sequence of bytes from the current stream to a byte array starting at a specified position for a specified number of bytes, advances the position within the stream by the number of bytes read, and monitors cancellation requests.</summary>
1484
+
<returns>A task that represents the asynchronous read operation. The value of its <seecref="P:System.Threading.Tasks.Task`1.Result" /> property contains the total number of bytes read into the buffer. The result value can be less than the number of bytes requested if the number of bytes currently available is less than the requested number, or it can be 0 (zero) if the end of the stream has been reached.</returns>
1485
+
<remarks>
1486
+
<formattype="text/markdown">
1487
+
<] app or [!INCLUDE[desktop_appname](~/includes/desktop-appname-md.md)] app where a time-consuming stream operation can block the UI thread and make your app appear as if it is not working. The async methods are used in conjunction with the `async` and `await` keywords in Visual Basic and C#.
1492
+
1493
+
Use the <xref:System.IO.Pipes.PipeStream.CanRead%2A> property to determine whether the current instance supports reading.
1494
+
1495
+
If the operation is canceled before it completes, the returned task contains the <xref:System.Threading.Tasks.TaskStatus.Canceled?displayProperty=nameWithType> value for the <xref:System.Threading.Tasks.Task.Status%2A> property.
1496
+
1497
+
]]></format>
1498
+
</remarks>
1499
+
<exceptioncref="T:System.NotSupportedException">The stream does not support reading.</exception>
1500
+
<exceptioncref="T:System.ObjectDisposedException">Cannot access a closed pipe.</exception>
The pipe handle has not been set. (Did your <seecref="T:System.IO.Pipes.PipeStream" /> implementation call <seecref="T:System.IO.Pipes.PipeStream.InitializeHandle(Microsoft.Win32.SafeHandles.SafePipeHandle,System.Boolean,System.Boolean)" />?
<paramname="buffer">A region of memory. This method copies the contents of this region to the current stream.</param>
1933
+
<summary>Writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written.</summary>
1934
+
<remarks><formattype="text/markdown"><![CDATA[
1935
+
1936
+
## Remarks
1937
+
1938
+
Use the <xref:System.IO.Pipes.PipeStream.CanWrite%2A> property to determine whether the current instance supports writing. Use the <xref:System.IO.Pipes.PipeStream.WriteAsync%2A> method to write asynchronously to the current stream.
1939
+
1940
+
If the write operation is successful, the position within the stream advances by the number of bytes written. If an exception occurs, the position within the stream remains unchanged.
1941
+
1942
+
]]></format>
1943
+
</remarks>
1944
+
<exceptioncref="T:System.NotSupportedException">The stream does not support writing.</exception>
1945
+
<exceptioncref="T:System.ObjectDisposedException">Cannot access a closed pipe.</exception>
1946
+
<exceptioncref="T:System.IOException">The pipe is broken.</exception>
The pipe handle has not been set. (Did your <seecref="T:System.IO.Pipes.PipeStream" /> implementation call <seecref="T:System.IO.Pipes.PipeStream.InitializeHandle(Microsoft.Win32.SafeHandles.SafePipeHandle,System.Boolean,System.Boolean)" />?
<paramname="cancellationToken">To be added.</param>
1946
-
<summary>To be added.</summary>
1947
-
<returns>To be added.</returns>
1948
-
<remarks>To be added.</remarks>
2052
+
<paramname="buffer">The region of memory to write data from.</param>
2053
+
<paramname="cancellationToken">The token to monitor for cancellation requests. The default value is <seecref="P:System.Threading.CancellationToken.None" />.</param>
2054
+
<summary>Asynchronously writes a sequence of bytes to the current stream, advances the current position within this stream by the number of bytes written, and monitors cancellation requests.</summary>
2055
+
<returns>A task that represents the asynchronous write operation.</returns>
2056
+
<remarks>
2057
+
<formattype="text/markdown"><] app or [!INCLUDE[desktop_appname](~/includes/desktop-appname-md.md)] app where a time-consuming stream operation can block the UI thread and make your app appear as if it is not working. The async methods are used in conjunction with the `async` and `await` keywords in Visual Basic and C#.
2062
+
2063
+
Use the <xref:System.IO.Pipes.PipeStream.CanWrite%2A> property to determine whether the current instance supports writing.
2064
+
2065
+
If the operation is canceled before it completes, the returned task contains the <xref:System.Threading.Tasks.TaskStatus.Canceled?displayProperty=nameWithtype> value for the <xref:System.Threading.Tasks.Task.Status%2A> property.
2066
+
2067
+
]]></format>
2068
+
</remarks>
2069
+
<exceptioncref="T:System.NotSupportedException">Stream does not support writing.</exception>
2070
+
<exceptioncref="T:System.ObjectDisposedException">Cannot access a closed pipe.</exception>
2071
+
<exceptioncref="T:System.IOException">The pipe is broken.</exception>
The pipe handle has not been set. (Did your <seecref="T:System.IO.Pipes.PipeStream" /> implementation call <seecref="T:System.IO.Pipes.PipeStream.InitializeHandle(Microsoft.Win32.SafeHandles.SafePipeHandle,System.Boolean,System.Boolean)" />?
<paramname="cancellationToken">To be added.</param>
1985
-
<summary>To be added.</summary>
1986
-
<returns>To be added.</returns>
1987
-
<remarks>To be added.</remarks>
2115
+
<paramname="buffer">The buffer to write data from.</param>
2116
+
<paramname="offset">The zero-based byte offset in <paramrefname="buffer" /> from which to begin copying bytes to the stream.</param>
2117
+
<paramname="count">The maximum number of bytes to write.</param>
2118
+
<paramname="cancellationToken">The token to monitor for cancellation requests. The default value is <seecref="P:System.Threading.CancellationToken.None" />.</param>
2119
+
<summary>Asynchronously writes a specified number of bytes from a byte array starting at a specified position, advances the current position within this stream by the number of bytes written, and monitors cancellation requests.</summary>
2120
+
<returns>A task that represents the asynchronous write operation.</returns>
2121
+
<remarks>
2122
+
<formattype="text/markdown">
2123
+
<] app or [!INCLUDE[desktop_appname](~/includes/desktop-appname-md.md)] app where a time-consuming stream operation can block the UI thread and make your app appear as if it is not working. The async methods are used in conjunction with the `async` and `await` keywords in Visual Basic and C#.
2128
+
2129
+
Use the <xref:System.IO.Pipes.PipeStream.CanWrite%2A> property to determine whether the current instance supports writing.
2130
+
2131
+
If the operation is canceled before it completes, the returned task contains the <xref:System.Threading.Tasks.TaskStatus.Canceled?displayProperty=nameWithType> value for the <xref:System.Threading.Tasks.Task.Status%2A> property.
2132
+
2133
+
]]></format>
2134
+
</remarks>
2135
+
<exceptioncref="T:System.ArgumentNullException"><paramrefname="buffer" /> is <seelangword="null" />.</exception>
<exceptioncref="T:System.ArgumentException"><paramrefname="buffer" />.Length - <paramrefname="offset" /> is less than <paramrefname="count" />.</exception>
2144
+
<exceptioncref="T:System.NotSupportedException">Stream does not support writing.</exception>
2145
+
<exceptioncref="T:System.ObjectDisposedException">Cannot access a closed pipe.</exception>
2146
+
<exceptioncref="T:System.IOException">The pipe is broken.</exception>
The pipe handle has not been set. (Did your <seecref="T:System.IO.Pipes.PipeStream" /> implementation call <seecref="T:System.IO.Pipes.PipeStream.InitializeHandle(Microsoft.Win32.SafeHandles.SafePipeHandle,System.Boolean,System.Boolean)" />?
0 commit comments