1 <?xml version="1.0" encoding="utf-8"?><doc>
3 <name>System.IO.Pipes</name>
6 <member name="T:System.IO.Pipes.PipeTransmissionMode">
7 <summary>Specifies the transmission mode of the pipe.</summary>
9 <member name="F:System.IO.Pipes.PipeTransmissionMode.Byte">
10 <summary>Indicates that data in the pipe is transmitted and read as a stream of bytes.</summary>
13 <member name="F:System.IO.Pipes.PipeTransmissionMode.Message">
14 <summary>Indicates that data in the pipe is transmitted and read as a stream of messages.</summary>
17 <member name="T:System.IO.Pipes.PipeStreamImpersonationWorker">
18 <summary>Represents the method to call as the client.</summary>
20 <member name="T:System.IO.Pipes.PipeStream">
21 <summary>Exposes a <see cref="T:System.IO.Stream"></see> object around a pipe, which supports both anonymous and named pipes.</summary>
23 <member name="M:System.IO.Pipes.PipeStream.#ctor(System.IO.Pipes.PipeDirection,System.Int32)">
24 <summary>Initializes a new instance of the <see cref="T:System.IO.Pipes.PipeStream"></see> class using the specified <see cref="T:System.IO.Pipes.PipeDirection"></see> value and buffer size.</summary>
25 <param name="direction">One of the <see cref="T:System.IO.Pipes.PipeDirection"></see> values that indicates the direction of the pipe object.</param>
26 <param name="bufferSize">A positive <see cref="T:System.Int32"></see> value greater than or equal to 0 that indicates the buffer size.</param>
27 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="direction">direction</paramref> is not a valid <see cref="System.IO.Pipes.PipeDirection"></see> value.
29 <paramref name="bufferSize">bufferSize</paramref> is less than 0.</exception>
31 <member name="M:System.IO.Pipes.PipeStream.#ctor(System.IO.Pipes.PipeDirection,System.IO.Pipes.PipeTransmissionMode,System.Int32)">
32 <summary>Initializes a new instance of the <see cref="T:System.IO.Pipes.PipeStream"></see> class using the specified <see cref="T:System.IO.Pipes.PipeDirection"></see>, <see cref="T:System.IO.Pipes.PipeTransmissionMode"></see>, and buffer size.</summary>
33 <param name="direction">One of the <see cref="T:System.IO.Pipes.PipeDirection"></see> values that indicates the direction of the pipe object.</param>
34 <param name="transmissionMode">One of the <see cref="T:System.IO.Pipes.PipeTransmissionMode"></see> values that indicates the transmission mode of the pipe object.</param>
35 <param name="outBufferSize">A positive <see cref="T:System.Int32"></see> value greater than or equal to 0 that indicates the buffer size.</param>
36 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="direction">direction</paramref> is not a valid <see cref="System.IO.Pipes.PipeDirection"></see> value.
38 <paramref name="transmissionMode">transmissionMode</paramref> is not a valid <see cref="System.IO.Pipes.PipeTransmissionMode"></see> value.
40 <paramref name="bufferSize">bufferSize</paramref> is less than 0.</exception>
42 <member name="M:System.IO.Pipes.PipeStream.BeginRead(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object)">
43 <summary>Begins an asynchronous read operation.</summary>
44 <param name="buffer">The buffer to read data into.</param>
45 <param name="offset">The byte offset in buffer at which to begin reading.</param>
46 <param name="count">The maximum number of bytes to read.</param>
47 <param name="callback">The method to call when the asynchronous read operation is completed.</param>
48 <param name="state">A user-provided object that distinguishes this particular asynchronous read request from other requests.</param>
49 <returns>An <see cref="T:System.IAsyncResult"></see> object that references the asynchronous read.</returns>
50 <exception cref="T:System.ArgumentNullException"><paramref name="buffer">buffer</paramref> is <see langword="null"></see>.</exception>
51 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="offset">offset</paramref> is less than 0.
53 <paramref name="count">count</paramref> is less than 0.</exception>
54 <exception cref="T:System.ArgumentException"><paramref name="count">count</paramref> is greater than the number of bytes available in <paramref name="buffer">buffer</paramref>.</exception>
55 <exception cref="T:System.ObjectDisposedException">The pipe is closed.</exception>
56 <exception cref="T:System.NotSupportedException">The pipe does not support read operations.</exception>
57 <exception cref="T:System.InvalidOperationException">The pipe is disconnected, waiting to connect, or the handle has not been set.</exception>
58 <exception cref="T:System.IO.IOException">The pipe is broken or another I/O error occurred.</exception>
60 <member name="M:System.IO.Pipes.PipeStream.BeginWrite(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object)">
61 <summary>Begins an asynchronous write operation.</summary>
62 <param name="buffer">The buffer that contains the data to write to the current stream.</param>
63 <param name="offset">The zero-based byte offset in buffer at which to begin copying bytes to the current stream.</param>
64 <param name="count">The maximum number of bytes to write.</param>
65 <param name="callback">The method to call when the asynchronous write operation is completed.</param>
66 <param name="state">A user-provided object that distinguishes this particular asynchronous write request from other requests.</param>
67 <returns>An <see cref="T:System.IAsyncResult"></see> object that references the asynchronous write operation.</returns>
68 <exception cref="T:System.ArgumentNullException"><paramref name="buffer">buffer</paramref> is <see langword="null"></see>.</exception>
69 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="offset">offset</paramref> is less than 0.
71 <paramref name="count">count</paramref> is less than 0.</exception>
72 <exception cref="T:System.ArgumentException"><paramref name="count">count</paramref> is greater than the number of bytes available in <paramref name="buffer">buffer</paramref>.</exception>
73 <exception cref="T:System.ObjectDisposedException">The pipe is closed.</exception>
74 <exception cref="T:System.NotSupportedException">The pipe does not support write operations.</exception>
75 <exception cref="T:System.InvalidOperationException">The pipe is disconnected, waiting to connect, or the handle has not been set.</exception>
76 <exception cref="T:System.IO.IOException">The pipe is broken or another I/O error occurred.</exception>
78 <member name="P:System.IO.Pipes.PipeStream.CanRead">
79 <summary>Gets a value indicating whether the current stream supports read operations.</summary>
80 <returns><see langword="true"></see> if the stream supports read operations; otherwise, <see langword="false"></see>.</returns>
82 <member name="P:System.IO.Pipes.PipeStream.CanSeek">
83 <summary>Gets a value indicating whether the current stream supports seek operations.</summary>
84 <returns><see langword="false"></see> in all cases.</returns>
86 <member name="P:System.IO.Pipes.PipeStream.CanWrite">
87 <summary>Gets a value indicating whether the current stream supports write operations.</summary>
88 <returns><see langword="true"></see> if the stream supports write operations; otherwise, <see langword="false"></see>.</returns>
90 <member name="M:System.IO.Pipes.PipeStream.CheckPipePropertyOperations">
91 <summary>Verifies that the pipe is in a proper state for getting or setting properties.</summary>
93 <member name="M:System.IO.Pipes.PipeStream.CheckReadOperations">
94 <summary>Verifies that the pipe is in a connected state for read operations.</summary>
96 <member name="M:System.IO.Pipes.PipeStream.CheckWriteOperations">
97 <summary>Verifies that the pipe is in a connected state for write operations.</summary>
99 <member name="M:System.IO.Pipes.PipeStream.Dispose(System.Boolean)">
100 <summary>Releases the unmanaged resources used by the <see cref="T:System.IO.Pipes.PipeStream"></see> class and optionally releases the managed resources.</summary>
101 <param name="disposing"><see langword="true"></see> to release both managed and unmanaged resources; <see langword="false"></see> to release only unmanaged resources.</param>
103 <member name="M:System.IO.Pipes.PipeStream.EndRead(System.IAsyncResult)">
104 <summary>Ends a pending asynchronous read request.</summary>
105 <param name="asyncResult">The reference to the pending asynchronous request.</param>
106 <returns>The number of bytes that were read. A return value of 0 indicates the end of the stream (the pipe has been closed).</returns>
107 <exception cref="T:System.ArgumentNullException"><paramref name="asyncResult">asyncResult</paramref> is <see langword="null"></see>.</exception>
108 <exception cref="T:System.ArgumentException"><paramref name="asyncResult">asyncResult</paramref> did not originate from a <see cref="System.IO.Pipes.PipeStream.BeginRead(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object)"></see> method on the current stream.</exception>
109 <exception cref="T:System.IO.IOException">The stream is closed or an internal error has occurred.</exception>
111 <member name="M:System.IO.Pipes.PipeStream.EndWrite(System.IAsyncResult)">
112 <summary>Ends a pending asynchronous write request.</summary>
113 <param name="asyncResult">The reference to the pending asynchronous request.</param>
114 <exception cref="T:System.ArgumentNullException"><paramref name="asyncResult">asyncResult</paramref> is <see langword="null"></see>.</exception>
115 <exception cref="T:System.ArgumentException"><paramref name="asyncResult">asyncResult</paramref> did not originate from a <see cref="System.IO.Pipes.PipeStream.BeginWrite(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object)"></see> method on the current stream.</exception>
116 <exception cref="T:System.IO.IOException">The stream is closed or an internal error has occurred.</exception>
118 <member name="M:System.IO.Pipes.PipeStream.Flush">
119 <summary>Clears the buffer for the current stream and causes any buffered data to be written to the underlying device.</summary>
120 <exception cref="T:System.ObjectDisposedException">The pipe is closed.</exception>
121 <exception cref="T:System.NotSupportedException">The pipe does not support write operations.</exception>
122 <exception cref="T:System.IO.IOException">The pipe is broken or another I/O error occurred.</exception>
124 <member name="P:System.IO.Pipes.PipeStream.InBufferSize">
125 <summary>Gets the size, in bytes, of the inbound buffer for a pipe.</summary>
126 <returns>An integer value that represents the inbound buffer size, in bytes.</returns>
127 <exception cref="T:System.NotSupportedException">The stream is unreadable.</exception>
128 <exception cref="T:System.InvalidOperationException">The pipe is waiting to connect.</exception>
129 <exception cref="T:System.IO.IOException">The pipe is broken or another I/O error occurred.</exception>
131 <member name="M:System.IO.Pipes.PipeStream.InitializeHandle(Microsoft.Win32.SafeHandles.SafePipeHandle,System.Boolean,System.Boolean)">
132 <summary>Initializes a <see cref="T:System.IO.Pipes.PipeStream"></see> object from the specified <see cref="T:Microsoft.Win32.SafeHandles.SafePipeHandle"></see> object.</summary>
133 <param name="handle">The <see cref="T:Microsoft.Win32.SafeHandles.SafePipeHandle"></see> object of the pipe to initialize.</param>
134 <param name="isExposed"><see langword="true"></see> to expose the handle; otherwise, <see langword="false"></see>.</param>
135 <param name="isAsync"><see langword="true"></see> to indicate that the handle was opened asynchronously; otherwise, <see langword="false"></see>.</param>
136 <exception cref="T:System.IO.IOException">A handle cannot be bound to the pipe.</exception>
138 <member name="P:System.IO.Pipes.PipeStream.IsAsync">
139 <summary>Gets a value indicating whether a <see cref="T:System.IO.Pipes.PipeStream"></see> object was opened asynchronously or synchronously.</summary>
140 <returns><see langword="true"></see> if the <see cref="T:System.IO.Pipes.PipeStream"></see> object was opened asynchronously; otherwise, <see langword="false"></see>.</returns>
142 <member name="P:System.IO.Pipes.PipeStream.IsConnected">
143 <summary>Gets or sets a value indicating whether a <see cref="T:System.IO.Pipes.PipeStream"></see> object is connected.</summary>
144 <returns><see langword="true"></see> if the <see cref="T:System.IO.Pipes.PipeStream"></see> object is connected; otherwise, <see langword="false"></see>.</returns>
146 <member name="P:System.IO.Pipes.PipeStream.IsHandleExposed">
147 <summary>Gets a value indicating whether a handle to a <see cref="T:System.IO.Pipes.PipeStream"></see> object is exposed.</summary>
148 <returns><see langword="true"></see> if a handle to the <see cref="T:System.IO.Pipes.PipeStream"></see> object is exposed; otherwise, <see langword="false"></see>.</returns>
150 <member name="P:System.IO.Pipes.PipeStream.IsMessageComplete">
151 <summary>Gets a value indicating whether there is more data in the message returned from the most recent read operation.</summary>
152 <returns><see langword="true"></see> if there are no more characters to read in the message; otherwise, <see langword="false"></see>.</returns>
153 <exception cref="T:System.InvalidOperationException">The pipe is not connected.
155 The pipe handle has not been set.
157 The pipe&#39;s <see cref="System.IO.Pipes.PipeStream.ReadMode"></see> property value is not <see cref="System.IO.Pipes.PipeTransmissionMode.Message"></see>.</exception>
158 <exception cref="T:System.ObjectDisposedException">The pipe is closed.</exception>
160 <member name="P:System.IO.Pipes.PipeStream.Length">
161 <summary>Gets the length of a stream, in bytes.</summary>
162 <returns>0 in all cases.</returns>
163 <exception cref="T:System.NotSupportedException">Always thrown.</exception>
165 <member name="P:System.IO.Pipes.PipeStream.OutBufferSize">
166 <summary>Gets the size, in bytes, of the outbound buffer for a pipe.</summary>
167 <returns>The outbound buffer size, in bytes.</returns>
168 <exception cref="T:System.NotSupportedException">The stream is unwriteable.</exception>
169 <exception cref="T:System.InvalidOperationException">The pipe is waiting to connect.</exception>
170 <exception cref="T:System.IO.IOException">The pipe is broken or another I/O error occurred.</exception>
172 <member name="P:System.IO.Pipes.PipeStream.Position">
173 <summary>Gets or sets the current position of the current stream.</summary>
174 <returns>0 in all cases.</returns>
175 <exception cref="T:System.NotSupportedException">Always thrown.</exception>
177 <member name="M:System.IO.Pipes.PipeStream.Read(System.Byte[],System.Int32,System.Int32)">
178 <summary>Reads a block of bytes from a stream and writes the data to a specified buffer.</summary>
179 <param name="buffer">When this method returns, contains the specified byte array with the values between offset and (offset + count - 1) replaced by the bytes read from the current source.</param>
180 <param name="offset">The byte offset in the buffer array at which the bytes that are read will be placed.</param>
181 <param name="count">The maximum number of bytes to read.</param>
182 <returns>The total number of bytes that are read into <paramref name="buffer">buffer</paramref>. 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>
183 <exception cref="T:System.ArgumentNullException"><paramref name="buffer">buffer</paramref> is <see langword="null"></see>.</exception>
184 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="offset">offset</paramref> is less than 0.
186 <paramref name="count">count</paramref> is less than 0.</exception>
187 <exception cref="T:System.ArgumentException"><paramref name="count">count</paramref> is greater than the number of bytes available in <paramref name="buffer">buffer</paramref>.</exception>
188 <exception cref="T:System.ObjectDisposedException">The pipe is closed.</exception>
189 <exception cref="T:System.NotSupportedException">The pipe does not support read operations.</exception>
190 <exception cref="T:System.InvalidOperationException">The pipe is disconnected, waiting to connect, or the handle has not been set.</exception>
191 <exception cref="T:System.IO.IOException">Any I/O error occurred.</exception>
193 <member name="M:System.IO.Pipes.PipeStream.ReadAsync(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
194 <param name="buffer"></param>
195 <param name="offset"></param>
196 <param name="count"></param>
197 <param name="cancellationToken"></param>
200 <member name="M:System.IO.Pipes.PipeStream.ReadByte">
201 <summary>Reads a byte from a pipe.</summary>
202 <returns>The byte, cast to <see cref="T:System.Int32"></see>, or -1 indicates the end of the stream (the pipe has been closed).</returns>
203 <exception cref="T:System.ObjectDisposedException">The pipe is closed.</exception>
204 <exception cref="T:System.NotSupportedException">The pipe does not support read operations.</exception>
205 <exception cref="T:System.InvalidOperationException">The pipe is disconnected, waiting to connect, or the handle has not been set.</exception>
206 <exception cref="T:System.IO.IOException">Any I/O error occurred.</exception>
208 <member name="P:System.IO.Pipes.PipeStream.ReadMode">
209 <summary>Gets or sets the reading mode for a <see cref="T:System.IO.Pipes.PipeStream"></see> object.</summary>
210 <returns>One of the <see cref="T:System.IO.Pipes.PipeTransmissionMode"></see> values that indicates how the <see cref="T:System.IO.Pipes.PipeStream"></see> object reads from the pipe.</returns>
211 <exception cref="T:System.ArgumentOutOfRangeException">The supplied value is not a valid <see cref="System.IO.Pipes.PipeTransmissionMode"></see> value.</exception>
212 <exception cref="T:System.NotSupportedException">The supplied value is not a supported <see cref="System.IO.Pipes.PipeTransmissionMode"></see> value for this pipe stream.</exception>
213 <exception cref="T:System.InvalidOperationException">The handle has not been set.
215 The pipe is waiting to connect with a named client.</exception>
216 <exception cref="T:System.IO.IOException">The pipe is broken or an I/O error occurred with a named client.</exception>
218 <member name="P:System.IO.Pipes.PipeStream.SafePipeHandle">
219 <summary>Gets the safe handle for the local end of the pipe that the current <see cref="T:System.IO.Pipes.PipeStream"></see> object encapsulates.</summary>
220 <returns>A <see cref="T:Microsoft.Win32.SafeHandles.SafePipeHandle"></see> object for the pipe that is encapsulated by the current <see cref="T:System.IO.Pipes.PipeStream"></see> object.</returns>
221 <exception cref="T:System.InvalidOperationException">The pipe handle has not been set.</exception>
222 <exception cref="T:System.ObjectDisposedException">The pipe is closed.</exception>
224 <member name="M:System.IO.Pipes.PipeStream.Seek(System.Int64,System.IO.SeekOrigin)">
225 <summary>Sets the current position of the current stream to the specified value.</summary>
226 <param name="offset">The point, relative to origin, to begin seeking from.</param>
227 <param name="origin">Specifies the beginning, the end, or the current position as a reference point for offset, using a value of type <see cref="T:System.IO.SeekOrigin"></see>.</param>
228 <returns>The new position in the stream.</returns>
230 <member name="M:System.IO.Pipes.PipeStream.SetLength(System.Int64)">
231 <summary>Sets the length of the current stream to the specified value.</summary>
232 <param name="value">The new length of the stream.</param>
234 <member name="P:System.IO.Pipes.PipeStream.TransmissionMode">
235 <summary>Gets the pipe transmission mode supported by the current pipe.</summary>
236 <returns>One of the <see cref="T:System.IO.Pipes.PipeTransmissionMode"></see> values that indicates the transmission mode supported by the current pipe.</returns>
237 <exception cref="T:System.ObjectDisposedException">The pipe is closed.</exception>
238 <exception cref="T:System.InvalidOperationException">The handle has not been set.
240 The pipe is waiting to connect in an anonymous client/server operation or with a named client.</exception>
241 <exception cref="T:System.IO.IOException">The pipe is broken or another I/O error occurred.</exception>
243 <member name="M:System.IO.Pipes.PipeStream.WaitForPipeDrain">
244 <summary>Waits for the other end of the pipe to read all sent bytes.</summary>
245 <exception cref="T:System.ObjectDisposedException">The pipe is closed.</exception>
246 <exception cref="T:System.NotSupportedException">The pipe does not support write operations.</exception>
247 <exception cref="T:System.IO.IOException">The pipe is broken or another I/O error occurred.</exception>
249 <member name="M:System.IO.Pipes.PipeStream.Write(System.Byte[],System.Int32,System.Int32)">
250 <summary>Writes a block of bytes to the current stream using data from a buffer.</summary>
251 <param name="buffer">The buffer that contains data to write to the pipe.</param>
252 <param name="offset">The zero-based byte offset in buffer at which to begin copying bytes to the current stream.</param>
253 <param name="count">The maximum number of bytes to write to the current stream.</param>
254 <exception cref="T:System.ArgumentNullException"><paramref name="buffer">buffer</paramref> is <see langword="null"></see>.</exception>
255 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="offset">offset</paramref> is less than 0.
257 <paramref name="count">count</paramref> is less than 0.</exception>
258 <exception cref="T:System.ArgumentException"><paramref name="count">count</paramref> is greater than the number of bytes available in <paramref name="buffer">buffer</paramref>.</exception>
259 <exception cref="T:System.ObjectDisposedException">The pipe is closed.</exception>
260 <exception cref="T:System.NotSupportedException">The pipe does not support write operations.</exception>
261 <exception cref="T:System.IO.IOException">The pipe is broken or another I/O error occurred.</exception>
263 <member name="M:System.IO.Pipes.PipeStream.WriteAsync(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
264 <param name="buffer"></param>
265 <param name="offset"></param>
266 <param name="count"></param>
267 <param name="cancellationToken"></param>
270 <member name="M:System.IO.Pipes.PipeStream.WriteByte(System.Byte)">
271 <summary>Writes a byte to the current stream.</summary>
272 <param name="value">The byte to write to the stream.</param>
273 <exception cref="T:System.ObjectDisposedException">The pipe is closed.</exception>
274 <exception cref="T:System.NotSupportedException">The pipe does not support write operations.</exception>
275 <exception cref="T:System.InvalidOperationException">The pipe is disconnected, waiting to connect, or the handle has not been set.</exception>
276 <exception cref="T:System.IO.IOException">The pipe is broken or another I/O error occurred.</exception>
278 <member name="T:System.IO.Pipes.PipeOptions">
279 <summary>Provides options for creating a <see cref="T:System.IO.Pipes.PipeStream"></see> object. This enumeration has a <see cref="T:System.FlagsAttribute"></see> attribute that allows a bitwise combination of its member values.</summary>
281 <member name="F:System.IO.Pipes.PipeOptions.Asynchronous">
282 <summary>Indicates that the pipe can be used for asynchronous reading and writing.</summary>
285 <member name="F:System.IO.Pipes.PipeOptions.CurrentUserOnly">
288 <member name="F:System.IO.Pipes.PipeOptions.None">
289 <summary>Indicates that there are no additional parameters.</summary>
292 <member name="F:System.IO.Pipes.PipeOptions.WriteThrough">
293 <summary>Indicates that the system should write through any intermediate cache and go directly to the pipe.</summary>
296 <member name="T:System.IO.Pipes.PipeDirection">
297 <summary>Specifies the direction of the pipe.</summary>
299 <member name="F:System.IO.Pipes.PipeDirection.In">
300 <summary>Specifies that the pipe direction is in.</summary>
303 <member name="F:System.IO.Pipes.PipeDirection.InOut">
304 <summary>Specifies that the pipe direction is two-way.</summary>
307 <member name="F:System.IO.Pipes.PipeDirection.Out">
308 <summary>Specifies that the pipe direction is out.</summary>
311 <member name="T:System.IO.Pipes.NamedPipeServerStream">
312 <summary>Exposes a <see cref="T:System.IO.Stream"></see> around a named pipe, supporting both synchronous and asynchronous read and write operations.</summary>
314 <member name="M:System.IO.Pipes.NamedPipeServerStream.#ctor(System.String)">
315 <summary>Initializes a new instance of the <see cref="T:System.IO.Pipes.NamedPipeServerStream"></see> class with the specified pipe name.</summary>
316 <param name="pipeName">The name of the pipe.</param>
317 <exception cref="T:System.ArgumentNullException"><paramref name="pipeName">pipeName</paramref> is <see langword="null"></see>.</exception>
318 <exception cref="T:System.ArgumentException"><paramref name="pipeName">pipeName</paramref> is a zero-length string.</exception>
319 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="pipeName">pipeName</paramref> is set to &quot;anonymous&quot;.</exception>
320 <exception cref="T:System.NotSupportedException"><paramref name="pipeName">pipeName</paramref> contains a colon (&quot;:&quot;).</exception>
321 <exception cref="T:System.PlatformNotSupportedException">The operating system is Windows Millennium Edition, Windows 98, or Windows 95, which are not supported.</exception>
322 <exception cref="T:System.IO.IOException">The maximum number of server instances has been exceeded.</exception>
324 <member name="M:System.IO.Pipes.NamedPipeServerStream.#ctor(System.String,System.IO.Pipes.PipeDirection,System.Int32,System.IO.Pipes.PipeTransmissionMode,System.IO.Pipes.PipeOptions,System.Int32,System.Int32)">
325 <summary>Initializes a new instance of the <see cref="T:System.IO.Pipes.NamedPipeServerStream"></see> class with the specified pipe name, pipe direction, maximum number of server instances, transmission mode, pipe options, and recommended in and out buffer sizes.</summary>
326 <param name="pipeName">The name of the pipe.</param>
327 <param name="direction">One of the enumeration values that determines the direction of the pipe.</param>
328 <param name="maxNumberOfServerInstances">The maximum number of server instances that share the same name. You can pass <see cref="F:System.IO.Pipes.NamedPipeServerStream.MaxAllowedServerInstances"></see> for this value.</param>
329 <param name="transmissionMode">One of the enumeration values that determines the transmission mode of the pipe.</param>
330 <param name="options">One of the enumeration values that determines how to open or create the pipe.</param>
331 <param name="inBufferSize">A positive value greater than 0 that indicates the input buffer size.</param>
332 <param name="outBufferSize">A positive value greater than 0 that indicates the output buffer size.</param>
333 <exception cref="T:System.ArgumentNullException"><paramref name="pipeName">pipeName</paramref> is <see langword="null"></see>.</exception>
334 <exception cref="T:System.ArgumentException"><paramref name="pipeName">pipeName</paramref> is a zero-length string.</exception>
335 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="pipeName">pipeName</paramref> is set to &quot;anonymous&quot;.
337 <paramref name="direction">direction</paramref> is not a valid <see cref="System.IO.Pipes.PipeDirection"></see> value.
339 <paramref name="maxNumberofServerInstances">maxNumberofServerInstances</paramref> is less than -1 or greater than 254 (-1 indicates <see cref="System.IO.Pipes.NamedPipeServerStream.MaxAllowedServerInstances"></see>)
341 <paramref name="options">options</paramref> is not a valid <see cref="System.IO.Pipes.PipeOptions"></see> value.
343 <paramref name="inBufferSize">inBufferSize</paramref> is negative.</exception>
344 <exception cref="T:System.NotSupportedException"><paramref name="pipeName">pipeName</paramref> contains a colon (&quot;:&quot;).</exception>
345 <exception cref="T:System.PlatformNotSupportedException">The operating system is Windows Millennium Edition, Windows 98, or Windows 95, which are not supported.</exception>
346 <exception cref="T:System.IO.IOException">The maximum number of server instances has been exceeded.</exception>
348 <member name="M:System.IO.Pipes.NamedPipeServerStream.#ctor(System.String,System.IO.Pipes.PipeDirection,System.Int32,System.IO.Pipes.PipeTransmissionMode,System.IO.Pipes.PipeOptions)">
349 <summary>Initializes a new instance of the <see cref="T:System.IO.Pipes.NamedPipeServerStream"></see> class with the specified pipe name, pipe direction, maximum number of server instances, transmission mode, and pipe options.</summary>
350 <param name="pipeName">The name of the pipe.</param>
351 <param name="direction">One of the enumeration values that determines the direction of the pipe.</param>
352 <param name="maxNumberOfServerInstances">The maximum number of server instances that share the same name. You can pass <see cref="F:System.IO.Pipes.NamedPipeServerStream.MaxAllowedServerInstances"></see> for this value.</param>
353 <param name="transmissionMode">One of the enumeration values that determines the transmission mode of the pipe.</param>
354 <param name="options">One of the enumeration values that determines how to open or create the pipe.</param>
355 <exception cref="T:System.ArgumentNullException"><paramref name="pipeName">pipeName</paramref> is <see langword="null"></see>.</exception>
356 <exception cref="T:System.ArgumentException"><paramref name="pipeName">pipeName</paramref> is a zero-length string.</exception>
357 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="pipeName">pipeName</paramref> is set to &quot;anonymous&quot;.
359 <paramref name="direction">direction</paramref> is not a valid <see cref="System.IO.Pipes.PipeDirection"></see> value.
361 <paramref name="maxNumberofServerInstances">maxNumberofServerInstances</paramref> is less than -1 or greater than 254 (-1 indicates <see cref="System.IO.Pipes.NamedPipeServerStream.MaxAllowedServerInstances"></see>)
363 <paramref name="options">options</paramref> is not a valid <see cref="System.IO.Pipes.PipeOptions"></see> value.</exception>
364 <exception cref="T:System.NotSupportedException"><paramref name="pipeName">pipeName</paramref> contains a colon (&quot;:&quot;).</exception>
365 <exception cref="T:System.PlatformNotSupportedException">The operating system is Windows Millennium Edition, Windows 98, or Windows 95, which are not supported.</exception>
366 <exception cref="T:System.IO.IOException">The maximum number of server instances has been exceeded.</exception>
368 <member name="M:System.IO.Pipes.NamedPipeServerStream.#ctor(System.IO.Pipes.PipeDirection,System.Boolean,System.Boolean,Microsoft.Win32.SafeHandles.SafePipeHandle)">
369 <summary>Initializes a new instance of the <see cref="T:System.IO.Pipes.NamedPipeServerStream"></see> class from the specified pipe handle.</summary>
370 <param name="direction">One of the enumeration values that determines the direction of the pipe.</param>
371 <param name="isAsync"><see langword="true"></see> to indicate that the handle was opened asynchronously; otherwise, <see langword="false"></see>.</param>
372 <param name="isConnected"><see langword="true"></see> to indicate that the pipe is connected; otherwise, <see langword="false"></see>.</param>
373 <param name="safePipeHandle">A safe handle for the pipe that this <see cref="T:System.IO.Pipes.NamedPipeServerStream"></see> object will encapsulate.</param>
374 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="direction">direction</paramref> is not a valid <see cref="System.IO.Pipes.PipeDirection"></see> value.</exception>
375 <exception cref="T:System.ArgumentNullException"><paramref name="safePipeHandle">safePipeHandle</paramref> is <see langword="null"></see>.</exception>
376 <exception cref="T:System.ArgumentException"><paramref name="safePipeHandle">safePipeHandle</paramref> is an invalid handle.</exception>
377 <exception cref="T:System.IO.IOException"><paramref name="safePipeHandle">safePipeHandle</paramref> is not a valid pipe handle.
379 The maximum number of server instances has been exceeded.</exception>
381 <member name="M:System.IO.Pipes.NamedPipeServerStream.#ctor(System.String,System.IO.Pipes.PipeDirection,System.Int32)">
382 <summary>Initializes a new instance of the <see cref="T:System.IO.Pipes.NamedPipeServerStream"></see> class with the specified pipe name, pipe direction, and maximum number of server instances.</summary>
383 <param name="pipeName">The name of the pipe.</param>
384 <param name="direction">One of the enumeration values that determines the direction of the pipe.</param>
385 <param name="maxNumberOfServerInstances">The maximum number of server instances that share the same name. You can pass <see cref="F:System.IO.Pipes.NamedPipeServerStream.MaxAllowedServerInstances"></see> for this value.</param>
386 <exception cref="T:System.ArgumentNullException"><paramref name="pipeName">pipeName</paramref> is <see langword="null"></see>.</exception>
387 <exception cref="T:System.ArgumentException"><paramref name="pipeName">pipeName</paramref> is a zero-length string.</exception>
388 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="pipeName">pipeName</paramref> is set to &quot;anonymous&quot;.
390 <paramref name="direction">direction</paramref> is not a valid <see cref="System.IO.Pipes.PipeDirection"></see> value.
392 A non-negative number is required.
394 <paramref name="maxNumberofServerInstances">maxNumberofServerInstances</paramref> is less than -1 or greater than 254 (-1 indicates <see cref="System.IO.Pipes.NamedPipeServerStream.MaxAllowedServerInstances"></see>)
396 <see cref="System.IO.HandleInheritability.None"></see> or <see cref="System.IO.HandleInheritability.Inheritable"></see> is required.
398 Access rights is limited to the <see cref="System.IO.Pipes.PipeAccessRights.ChangePermissions"></see> , <see cref="System.IO.Pipes.PipeAccessRights.TakeOwnership"></see> , and <see cref="System.IO.Pipes.PipeAccessRights.AccessSystemSecurity"></see> flags.</exception>
399 <exception cref="T:System.NotSupportedException"><paramref name="pipeName">pipeName</paramref> contains a colon (&quot;:&quot;).</exception>
400 <exception cref="T:System.PlatformNotSupportedException">The operating system is Windows Millennium Edition, Windows 98, or Windows 95, which are not supported.</exception>
401 <exception cref="T:System.IO.IOException">The maximum number of server instances has been exceeded.</exception>
403 <member name="M:System.IO.Pipes.NamedPipeServerStream.#ctor(System.String,System.IO.Pipes.PipeDirection)">
404 <summary>Initializes a new instance of the <see cref="T:System.IO.Pipes.NamedPipeServerStream"></see> class with the specified pipe name and pipe direction.</summary>
405 <param name="pipeName">The name of the pipe.</param>
406 <param name="direction">One of the enumeration values that determines the direction of the pipe.</param>
407 <exception cref="T:System.ArgumentNullException"><paramref name="pipeName">pipeName</paramref> is <see langword="null"></see>.</exception>
408 <exception cref="T:System.ArgumentException"><paramref name="pipeName">pipeName</paramref> is a zero-length string.</exception>
409 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="pipeName">pipeName</paramref> is set to &quot;anonymous&quot;.
411 <paramref name="direction">direction</paramref> is not a valid <see cref="System.IO.Pipes.PipeDirection"></see> value.</exception>
412 <exception cref="T:System.NotSupportedException"><paramref name="pipeName">pipeName</paramref> contains a colon (&quot;:&quot;).</exception>
413 <exception cref="T:System.PlatformNotSupportedException">The operating system is Windows Millennium Edition, Windows 98, or Windows 95, which are not supported.</exception>
414 <exception cref="T:System.IO.IOException">The maximum number of server instances has been exceeded.</exception>
416 <member name="M:System.IO.Pipes.NamedPipeServerStream.#ctor(System.String,System.IO.Pipes.PipeDirection,System.Int32,System.IO.Pipes.PipeTransmissionMode)">
417 <summary>Initializes a new instance of the <see cref="T:System.IO.Pipes.NamedPipeServerStream"></see> class with the specified pipe name, pipe direction, maximum number of server instances, and transmission mode.</summary>
418 <param name="pipeName">The name of the pipe.</param>
419 <param name="direction">One of the enumeration values that determines the direction of the pipe.</param>
420 <param name="maxNumberOfServerInstances">The maximum number of server instances that share the same name. You can pass <see cref="F:System.IO.Pipes.NamedPipeServerStream.MaxAllowedServerInstances"></see> for this value.</param>
421 <param name="transmissionMode">One of the enumeration values that determines the transmission mode of the pipe.</param>
422 <exception cref="T:System.ArgumentNullException"><paramref name="pipeName">pipeName</paramref> is <see langword="null"></see>.</exception>
423 <exception cref="T:System.ArgumentException"><paramref name="pipeName">pipeName</paramref> is a zero-length string.</exception>
424 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="pipeName">pipeName</paramref> is set to &quot;anonymous&quot;.
426 <paramref name="direction">direction</paramref> is not a valid <see cref="System.IO.Pipes.PipeDirection"></see> value.
428 <paramref name="maxNumberofServerInstances">maxNumberofServerInstances</paramref> is less than -1 or greater than 254 (-1 indicates <see cref="System.IO.Pipes.NamedPipeServerStream.MaxAllowedServerInstances"></see>)</exception>
429 <exception cref="T:System.NotSupportedException"><paramref name="pipeName">pipeName</paramref> contains a colon (&quot;:&quot;).</exception>
430 <exception cref="T:System.PlatformNotSupportedException">The operating system is Windows Millennium Edition, Windows 98, or Windows 95, which are not supported.</exception>
431 <exception cref="T:System.IO.IOException">The maximum number of server instances has been exceeded.</exception>
433 <member name="M:System.IO.Pipes.NamedPipeServerStream.BeginWaitForConnection(System.AsyncCallback,System.Object)">
434 <summary>Begins an asynchronous operation to wait for a client to connect.</summary>
435 <param name="callback">The method to call when a client connects to the <see cref="T:System.IO.Pipes.NamedPipeServerStream"></see> object.</param>
436 <param name="state">A user-provided object that distinguishes this particular asynchronous request from other requests.</param>
437 <returns>An object that references the asynchronous request.</returns>
438 <exception cref="T:System.InvalidOperationException">The pipe was not opened asynchronously.
440 A pipe connection has already been established.
442 The pipe handle has not been set.</exception>
443 <exception cref="T:System.IO.IOException">The pipe connection has been broken.</exception>
444 <exception cref="T:System.ObjectDisposedException">The pipe is closed.</exception>
446 <member name="M:System.IO.Pipes.NamedPipeServerStream.Disconnect">
447 <summary>Disconnects the current connection.</summary>
448 <exception cref="T:System.InvalidOperationException">No pipe connections have been made yet.
450 The connected pipe has already disconnected.
452 The pipe handle has not been set.</exception>
453 <exception cref="T:System.ObjectDisposedException">The pipe is closed.</exception>
455 <member name="M:System.IO.Pipes.NamedPipeServerStream.EndWaitForConnection(System.IAsyncResult)">
456 <summary>Ends an asynchronous operation to wait for a client to connect.</summary>
457 <param name="asyncResult">The pending asynchronous request.</param>
458 <exception cref="T:System.ArgumentNullException"><paramref name="asyncResult">asyncResult</paramref> is <see langword="null"></see>.</exception>
459 <exception cref="T:System.InvalidOperationException">The pipe was not opened asynchronously.
461 The pipe handle has not been set.</exception>
462 <exception cref="T:System.IO.IOException">The pipe connection has been broken.</exception>
463 <exception cref="T:System.ObjectDisposedException">The pipe is closed.</exception>
465 <member name="M:System.IO.Pipes.NamedPipeServerStream.Finalize">
466 <summary>Releases unmanaged resources and performs other cleanup operations before the <see cref="T:System.IO.Pipes.NamedPipeServerStream"></see> instance is reclaimed by garbage collection.</summary>
468 <member name="M:System.IO.Pipes.NamedPipeServerStream.GetImpersonationUserName">
469 <summary>Gets the user name of the client on the other end of the pipe.</summary>
470 <returns>The user name of the client on the other end of the pipe.</returns>
471 <exception cref="T:System.InvalidOperationException">No pipe connections have been made yet.
473 The connected pipe has already disconnected.
475 The pipe handle has not been set.</exception>
476 <exception cref="T:System.ObjectDisposedException">The pipe is closed.</exception>
477 <exception cref="T:System.IO.IOException">The pipe connection has been broken.
479 The user name of the client is longer than 19 characters.</exception>
481 <member name="F:System.IO.Pipes.NamedPipeServerStream.MaxAllowedServerInstances">
482 <summary>Represents the maximum number of server instances that the system resources allow.</summary>
485 <member name="M:System.IO.Pipes.NamedPipeServerStream.RunAsClient(System.IO.Pipes.PipeStreamImpersonationWorker)">
486 <summary>Calls a delegate while impersonating the client.</summary>
487 <param name="impersonationWorker">The delegate that specifies a method to call.</param>
488 <exception cref="T:System.InvalidOperationException">No pipe connections have been made yet.
490 The connected pipe has already disconnected.
492 The pipe handle has not been set.</exception>
493 <exception cref="T:System.ObjectDisposedException">The pipe is closed.</exception>
494 <exception cref="T:System.IO.IOException">The pipe connection has been broken.
496 An I/O error occurred.</exception>
498 <member name="M:System.IO.Pipes.NamedPipeServerStream.WaitForConnection">
499 <summary>Waits for a client to connect to this <see cref="T:System.IO.Pipes.NamedPipeServerStream"></see> object.</summary>
500 <exception cref="T:System.InvalidOperationException">A pipe connection has already been established.
502 The pipe handle has not been set.</exception>
503 <exception cref="T:System.ObjectDisposedException">The pipe is closed.</exception>
504 <exception cref="T:System.IO.IOException">The pipe connection has been broken.</exception>
506 <member name="M:System.IO.Pipes.NamedPipeServerStream.WaitForConnectionAsync">
507 <summary>Asynchronously waits for a client to connect to this <see cref="T:System.IO.Pipes.NamedPipeServerStream"></see> object.</summary>
508 <returns>A task that represents the asynchronous wait operation.</returns>
510 <member name="M:System.IO.Pipes.NamedPipeServerStream.WaitForConnectionAsync(System.Threading.CancellationToken)">
511 <summary>Asynchronously waits for a client to connect to this <see cref="T:System.IO.Pipes.NamedPipeServerStream"></see> object and monitors cancellation requests.</summary>
512 <param name="cancellationToken">The token to monitor for cancellation requests.</param>
513 <returns>A task that represents the asynchronous wait operation.</returns>
515 <member name="T:System.IO.Pipes.NamedPipeClientStream">
516 <summary>Exposes a <see cref="T:System.IO.Stream"></see> around a named pipe, which supports both synchronous and asynchronous read and write operations.</summary>
518 <member name="M:System.IO.Pipes.NamedPipeClientStream.#ctor(System.String)">
519 <summary>Initializes a new instance of the <see cref="T:System.IO.Pipes.NamedPipeClientStream"></see> class with the specified pipe name.</summary>
520 <param name="pipeName">The name of the pipe.</param>
521 <exception cref="T:System.ArgumentNullException"><paramref name="pipeName">pipeName</paramref> is <see langword="null"></see>.</exception>
522 <exception cref="T:System.ArgumentException"><paramref name="pipeName">pipeName</paramref> is a zero-length string.</exception>
523 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="pipeName">pipeName</paramref> is set to &quot;anonymous&quot;.</exception>
525 <member name="M:System.IO.Pipes.NamedPipeClientStream.#ctor(System.String,System.String)">
526 <summary>Initializes a new instance of the <see cref="T:System.IO.Pipes.NamedPipeClientStream"></see> class with the specified pipe and server names.</summary>
527 <param name="serverName">The name of the remote computer to connect to, or &quot;.&quot; to specify the local computer.</param>
528 <param name="pipeName">The name of the pipe.</param>
529 <exception cref="T:System.ArgumentNullException"><paramref name="pipeName">pipeName</paramref> or <paramref name="serverName">serverName</paramref> is <see langword="null"></see>.</exception>
530 <exception cref="T:System.ArgumentException"><paramref name="pipeName">pipeName</paramref> or <paramref name="serverName">serverName</paramref> is a zero-length string.</exception>
531 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="pipeName">pipeName</paramref> is set to &quot;anonymous&quot;.</exception>
533 <member name="M:System.IO.Pipes.NamedPipeClientStream.#ctor(System.String,System.String,System.IO.Pipes.PipeDirection)">
534 <summary>Initializes a new instance of the <see cref="T:System.IO.Pipes.NamedPipeClientStream"></see> class with the specified pipe and server names, and the specified pipe direction.</summary>
535 <param name="serverName">The name of the remote computer to connect to, or &quot;.&quot; to specify the local computer.</param>
536 <param name="pipeName">The name of the pipe.</param>
537 <param name="direction">One of the enumeration values that determines the direction of the pipe.</param>
538 <exception cref="T:System.ArgumentNullException"><paramref name="pipeName">pipeName</paramref> or <paramref name="serverName">serverName</paramref> is <see langword="null"></see>.</exception>
539 <exception cref="T:System.ArgumentException"><paramref name="pipeName">pipeName</paramref> or <paramref name="serverName">serverName</paramref> is a zero-length string.</exception>
540 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="pipeName">pipeName</paramref> is set to &quot;anonymous&quot;.
542 <paramref name="direction">direction</paramref> is not a valid <see cref="System.IO.Pipes.PipeDirection"></see> value.</exception>
544 <member name="M:System.IO.Pipes.NamedPipeClientStream.#ctor(System.IO.Pipes.PipeDirection,System.Boolean,System.Boolean,Microsoft.Win32.SafeHandles.SafePipeHandle)">
545 <summary>Initializes a new instance of the <see cref="T:System.IO.Pipes.NamedPipeClientStream"></see> class for the specified pipe handle with the specified pipe direction.</summary>
546 <param name="direction">One of the enumeration values that determines the direction of the pipe.</param>
547 <param name="isAsync"><see langword="true"></see> to indicate that the handle was opened asynchronously; otherwise, <see langword="false"></see>.</param>
548 <param name="isConnected"><see langword="true"></see> to indicate that the pipe is connected; otherwise, <see langword="false"></see>.</param>
549 <param name="safePipeHandle">A safe handle for the pipe that this <see cref="T:System.IO.Pipes.NamedPipeClientStream"></see> object will encapsulate.</param>
550 <exception cref="T:System.IO.IOException">The stream has been closed.</exception>
551 <exception cref="T:System.ArgumentException"><paramref name="safePipeHandle">safePipeHandle</paramref> is not a valid handle.</exception>
552 <exception cref="T:System.ArgumentNullException"><paramref name="safePipeHandle">safePipeHandle</paramref> is <see langword="null"></see>.</exception>
553 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="direction">direction</paramref> is not a valid <see cref="System.IO.Pipes.PipeDirection"></see> value.</exception>
555 <member name="M:System.IO.Pipes.NamedPipeClientStream.#ctor(System.String,System.String,System.IO.Pipes.PipeDirection,System.IO.Pipes.PipeOptions)">
556 <summary>Initializes a new instance of the <see cref="T:System.IO.Pipes.NamedPipeClientStream"></see> class with the specified pipe and server names, and the specified pipe direction and pipe options.</summary>
557 <param name="serverName">The name of the remote computer to connect to, or &quot;.&quot; to specify the local computer.</param>
558 <param name="pipeName">The name of the pipe.</param>
559 <param name="direction">One of the enumeration values that determines the direction of the pipe.</param>
560 <param name="options">One of the enumeration values that determines how to open or create the pipe.</param>
561 <exception cref="T:System.ArgumentNullException"><paramref name="pipeName">pipeName</paramref> or <paramref name="serverName">serverName</paramref> is <see langword="null"></see>.</exception>
562 <exception cref="T:System.ArgumentException"><paramref name="pipeName">pipeName</paramref> or <paramref name="serverName">serverName</paramref> is a zero-length string.</exception>
563 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="pipeName">pipeName</paramref> is set to &quot;anonymous&quot;.
565 <paramref name="direction">direction</paramref> is not a valid <see cref="System.IO.Pipes.PipeDirection"></see> value.
567 <paramref name="options">options</paramref> is not a valid <see cref="System.IO.Pipes.PipeOptions"></see> value.</exception>
569 <member name="M:System.IO.Pipes.NamedPipeClientStream.#ctor(System.String,System.String,System.IO.Pipes.PipeDirection,System.IO.Pipes.PipeOptions,System.Security.Principal.TokenImpersonationLevel)">
570 <summary>Initializes a new instance of the <see cref="T:System.IO.Pipes.NamedPipeClientStream"></see> class with the specified pipe and server names, and the specified pipe direction, pipe options, and security impersonation level.</summary>
571 <param name="serverName">The name of the remote computer to connect to, or &quot;.&quot; to specify the local computer.</param>
572 <param name="pipeName">The name of the pipe.</param>
573 <param name="direction">One of the enumeration values that determines the direction of the pipe.</param>
574 <param name="options">One of the enumeration values that determines how to open or create the pipe.</param>
575 <param name="impersonationLevel">One of the enumeration values that determines the security impersonation level.</param>
576 <exception cref="T:System.ArgumentNullException"><paramref name="pipeName">pipeName</paramref> or <paramref name="serverName">serverName</paramref> is <see langword="null"></see>.</exception>
577 <exception cref="T:System.ArgumentException"><paramref name="pipeName">pipeName</paramref> or <paramref name="serverName">serverName</paramref> is a zero-length string.</exception>
578 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="pipeName">pipeName</paramref> is set to &quot;anonymous&quot;.
580 <paramref name="direction">direction</paramref> is not a valid <see cref="System.IO.Pipes.PipeDirection"></see> value.
582 <paramref name="options">options</paramref> is not a valid <see cref="System.IO.Pipes.PipeOptions"></see> value.
584 <paramref name="impersonationLevel">impersonationLevel</paramref> is not a valid <see cref="System.Security.Principal.TokenImpersonationLevel"></see> value.</exception>
586 <member name="M:System.IO.Pipes.NamedPipeClientStream.#ctor(System.String,System.String,System.IO.Pipes.PipeDirection,System.IO.Pipes.PipeOptions,System.Security.Principal.TokenImpersonationLevel,System.IO.HandleInheritability)">
587 <summary>Initializes a new instance of the <see cref="T:System.IO.Pipes.NamedPipeClientStream"></see> class with the specified pipe and server names, and the specified pipe direction, pipe options, security impersonation level, and inheritability mode.</summary>
588 <param name="serverName">The name of the remote computer to connect to, or &quot;.&quot; to specify the local computer.</param>
589 <param name="pipeName">The name of the pipe.</param>
590 <param name="direction">One of the enumeration values that determines the direction of the pipe.</param>
591 <param name="options">One of the enumeration values that determines how to open or create the pipe.</param>
592 <param name="impersonationLevel">One of the enumeration values that determines the security impersonation level.</param>
593 <param name="inheritability">One of the enumeration values that determines whether the underlying handle will be inheritable by child processes.</param>
594 <exception cref="T:System.ArgumentNullException"><paramref name="pipeName">pipeName</paramref> or <paramref name="serverName">serverName</paramref> is <see langword="null"></see>.</exception>
595 <exception cref="T:System.ArgumentException"><paramref name="pipeName">pipeName</paramref> or <paramref name="serverName">serverName</paramref> is a zero-length string.</exception>
596 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="pipeName">pipeName</paramref> is set to &quot;anonymous&quot;.
598 <paramref name="direction">direction</paramref> is not a valid <see cref="System.IO.Pipes.PipeDirection"></see> value.
600 <paramref name="options">options</paramref> is not a valid <see cref="System.IO.Pipes.PipeOptions"></see> value.
602 <paramref name="impersonationLevel">impersonationLevel</paramref> is not a valid <see cref="System.Security.Principal.TokenImpersonationLevel"></see> value.
604 <paramref name="inheritability">inheritability</paramref> is not a valid <see cref="System.IO.HandleInheritability"></see> value.</exception>
606 <member name="M:System.IO.Pipes.NamedPipeClientStream.Connect">
607 <summary>Connects to a waiting server with an infinite time-out value.</summary>
608 <exception cref="T:System.InvalidOperationException">The client is already connected.</exception>
610 <member name="M:System.IO.Pipes.NamedPipeClientStream.Connect(System.Int32)">
611 <summary>Connects to a waiting server within the specified time-out period.</summary>
612 <param name="timeout">The number of milliseconds to wait for the server to respond before the connection times out.</param>
613 <exception cref="T:System.TimeoutException">Could not connect to the server within the specified <paramref name="timeout">timeout</paramref> period.</exception>
614 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="timeout">timeout</paramref> is less than 0 and not set to <see cref="System.Threading.Timeout.Infinite"></see>.</exception>
615 <exception cref="T:System.InvalidOperationException">The client is already connected.</exception>
616 <exception cref="T:System.IO.IOException">The server is connected to another client and the time-out period has expired.</exception>
618 <member name="M:System.IO.Pipes.NamedPipeClientStream.ConnectAsync">
619 <summary>Asynchronously connects to a waiting server with an infinite timeout period.</summary>
620 <returns>A task that represents the asynchronous connect operation.</returns>
622 <member name="M:System.IO.Pipes.NamedPipeClientStream.ConnectAsync(System.Int32)">
623 <summary>Asynchronously connects to a waiting server within the specified timeout period.</summary>
624 <param name="timeout">The number of milliseconds to wait for the server to respond before the connection times out.</param>
625 <returns>A task that represents the asynchronous connect operation.</returns>
627 <member name="M:System.IO.Pipes.NamedPipeClientStream.ConnectAsync(System.Threading.CancellationToken)">
628 <summary>Asynchronously connects to a waiting server and monitors cancellation requests.</summary>
629 <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"></see>.</param>
630 <returns>A task that represents the asynchronous connect operation.</returns>
632 <member name="M:System.IO.Pipes.NamedPipeClientStream.ConnectAsync(System.Int32,System.Threading.CancellationToken)">
633 <summary>Asynchronously connects to a waiting server within the specified timeout period and monitors cancellation requests.</summary>
634 <param name="timeout">The number of milliseconds to wait for the server to respond before the connection times out.</param>
635 <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"></see>.</param>
636 <returns>A task that represents the asynchronous connect operation.</returns>
638 <member name="M:System.IO.Pipes.NamedPipeClientStream.Finalize">
639 <summary>Releases unmanaged resources and performs other cleanup operations before the <see cref="T:System.IO.Pipes.NamedPipeClientStream"></see> instance is reclaimed by garbage collection.</summary>
641 <member name="P:System.IO.Pipes.NamedPipeClientStream.NumberOfServerInstances">
642 <summary>Gets the number of server instances that share the same pipe name.</summary>
643 <returns>The number of server instances that share the same pipe name.</returns>
644 <exception cref="T:System.InvalidOperationException">The pipe handle has not been set.
646 The current <see cref="System.IO.Pipes.NamedPipeClientStream"></see> object has not yet connected to a <see cref="System.IO.Pipes.NamedPipeServerStream"></see> object.</exception>
647 <exception cref="T:System.IO.IOException">The pipe is broken or an I/O error occurred.</exception>
648 <exception cref="T:System.ObjectDisposedException">The underlying pipe handle is closed.</exception>
650 <member name="T:System.IO.Pipes.AnonymousPipeServerStream">
651 <summary>Exposes a stream around an anonymous pipe, which supports both synchronous and asynchronous read and write operations.</summary>
653 <member name="M:System.IO.Pipes.AnonymousPipeServerStream.#ctor">
654 <summary>Initializes a new instance of the <see cref="T:System.IO.Pipes.AnonymousPipeServerStream"></see> class.</summary>
656 <member name="M:System.IO.Pipes.AnonymousPipeServerStream.#ctor(System.IO.Pipes.PipeDirection)">
657 <summary>Initializes a new instance of the <see cref="T:System.IO.Pipes.AnonymousPipeServerStream"></see> class with the specified pipe direction.</summary>
658 <param name="direction">One of the enumeration values that determines the direction of the pipe.
659 Anonymous pipes can only be in one direction, so direction cannot be set to <see cref="F:System.IO.Pipes.PipeDirection.InOut"></see>.</param>
660 <exception cref="T:System.NotSupportedException"><paramref name="direction">direction</paramref> is set to <see cref="System.IO.Pipes.PipeDirection.InOut"></see>.</exception>
662 <member name="M:System.IO.Pipes.AnonymousPipeServerStream.#ctor(System.IO.Pipes.PipeDirection,System.IO.HandleInheritability)">
663 <summary>Initializes a new instance of the <see cref="T:System.IO.Pipes.AnonymousPipeServerStream"></see> class with the specified pipe direction and inheritability mode.</summary>
664 <param name="direction">One of the enumeration values that determines the direction of the pipe.
665 Anonymous pipes can only be in one direction, so direction cannot be set to <see cref="F:System.IO.Pipes.PipeDirection.InOut"></see>.</param>
666 <param name="inheritability">One of the enumeration values that determines whether the underlying handle can be inherited by child processes. Must be set to either <see cref="F:System.IO.HandleInheritability.None"></see> or <see cref="F:System.IO.HandleInheritability.Inheritable"></see>.</param>
667 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="inheritability">inheritability</paramref> is not set to either <see cref="System.IO.HandleInheritability.None"></see> or <see cref="System.IO.HandleInheritability.Inheritable"></see>.</exception>
668 <exception cref="T:System.NotSupportedException"><paramref name="direction">direction</paramref> is set to <see cref="System.IO.Pipes.PipeDirection.InOut"></see>.</exception>
670 <member name="M:System.IO.Pipes.AnonymousPipeServerStream.#ctor(System.IO.Pipes.PipeDirection,Microsoft.Win32.SafeHandles.SafePipeHandle,Microsoft.Win32.SafeHandles.SafePipeHandle)">
671 <summary>Initializes a new instance of the <see cref="T:System.IO.Pipes.AnonymousPipeServerStream"></see> class from the specified pipe handles.</summary>
672 <param name="direction">One of the enumeration values that determines the direction of the pipe.
673 Anonymous pipes can only be in one direction, so direction cannot be set to <see cref="F:System.IO.Pipes.PipeDirection.InOut"></see>.</param>
674 <param name="serverSafePipeHandle">A safe handle for the pipe that this <see cref="T:System.IO.Pipes.AnonymousPipeServerStream"></see> object will encapsulate.</param>
675 <param name="clientSafePipeHandle">A safe handle for the <see cref="T:System.IO.Pipes.AnonymousPipeClientStream"></see> object.</param>
676 <exception cref="T:System.ArgumentException"><paramref name="serverSafePipeHandle">serverSafePipeHandle</paramref> or <paramref name="clientSafePipeHandle">clientSafePipeHandle</paramref> is an invalid handle.</exception>
677 <exception cref="T:System.ArgumentNullException"><paramref name="serverSafePipeHandle">serverSafePipeHandle</paramref> or <paramref name="clientSafePipeHandle">clientSafePipeHandle</paramref> is <see langword="null"></see>.</exception>
678 <exception cref="T:System.NotSupportedException"><paramref name="direction">direction</paramref> is set to <see cref="System.IO.Pipes.PipeDirection.InOut"></see>.</exception>
679 <exception cref="T:System.IO.IOException">An I/O error, such as a disk error, has occurred.
681 The stream has been closed.</exception>
683 <member name="M:System.IO.Pipes.AnonymousPipeServerStream.#ctor(System.IO.Pipes.PipeDirection,System.IO.HandleInheritability,System.Int32)">
684 <summary>Initializes a new instance of the <see cref="T:System.IO.Pipes.AnonymousPipeServerStream"></see> class with the specified pipe direction, inheritability mode, and buffer size.</summary>
685 <param name="direction">One of the enumeration values that determines the direction of the pipe.
686 Anonymous pipes can only be in one direction, so direction cannot be set to <see cref="F:System.IO.Pipes.PipeDirection.InOut"></see>.</param>
687 <param name="inheritability">One of the enumeration values that determines whether the underlying handle can be inherited by child processes. Must be set to either <see cref="F:System.IO.HandleInheritability.None"></see> or <see cref="F:System.IO.HandleInheritability.Inheritable"></see>.</param>
688 <param name="bufferSize">The size of the buffer. This value must be greater than or equal to 0.</param>
689 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="inheritability">inheritability</paramref> is not set to either <see cref="System.IO.HandleInheritability.None"></see> or <see cref="System.IO.HandleInheritability.Inheritable"></see>.
691 <paramref name="bufferSize">bufferSize</paramref> is less than 0.</exception>
692 <exception cref="T:System.NotSupportedException"><paramref name="direction">direction</paramref> is set to <see cref="System.IO.Pipes.PipeDirection.InOut"></see>.</exception>
694 <member name="P:System.IO.Pipes.AnonymousPipeServerStream.ClientSafePipeHandle">
695 <summary>Gets the safe handle for the <see cref="T:System.IO.Pipes.AnonymousPipeClientStream"></see> object that is currently connected to the <see cref="T:System.IO.Pipes.AnonymousPipeServerStream"></see> object.</summary>
696 <returns>A handle for the <see cref="T:System.IO.Pipes.AnonymousPipeClientStream"></see> object that is currently connected to the <see cref="T:System.IO.Pipes.AnonymousPipeServerStream"></see> object.</returns>
698 <member name="M:System.IO.Pipes.AnonymousPipeServerStream.DisposeLocalCopyOfClientHandle">
699 <summary>Closes the local copy of the <see cref="T:System.IO.Pipes.AnonymousPipeClientStream"></see> object&#39;s handle.</summary>
701 <member name="M:System.IO.Pipes.AnonymousPipeServerStream.Finalize">
702 <summary>Releases unmanaged resources and performs other cleanup operations before the <see cref="T:System.IO.Pipes.AnonymousPipeServerStream"></see> instance is reclaimed by garbage collection.</summary>
704 <member name="M:System.IO.Pipes.AnonymousPipeServerStream.GetClientHandleAsString">
705 <summary>Gets the connected <see cref="T:System.IO.Pipes.AnonymousPipeClientStream"></see> object&#39;s handle as a string.</summary>
706 <returns>A string that represents the connected <see cref="T:System.IO.Pipes.AnonymousPipeClientStream"></see> object&#39;s handle.</returns>
708 <member name="P:System.IO.Pipes.AnonymousPipeServerStream.ReadMode">
709 <summary>Sets the reading mode for the <see cref="T:System.IO.Pipes.AnonymousPipeServerStream"></see> object. For anonymous pipes, transmission mode must be <see cref="F:System.IO.Pipes.PipeTransmissionMode.Byte"></see>.</summary>
710 <returns>The reading mode for the <see cref="T:System.IO.Pipes.AnonymousPipeServerStream"></see> object.</returns>
711 <exception cref="T:System.ArgumentOutOfRangeException">The transmission mode is not valid. For anonymous pipes, only <see cref="System.IO.Pipes.PipeTransmissionMode.Byte"></see> is supported.</exception>
712 <exception cref="T:System.NotSupportedException">The property is set to <see cref="System.IO.Pipes.PipeTransmissionMode.Message"></see>, which is not supported for anonymous pipes.</exception>
713 <exception cref="T:System.IO.IOException">The connection is broken or another I/O error occurs.</exception>
714 <exception cref="T:System.ObjectDisposedException">The pipe is closed.</exception>
716 <member name="P:System.IO.Pipes.AnonymousPipeServerStream.TransmissionMode">
717 <summary>Gets the pipe transmission mode that is supported by the current pipe.</summary>
718 <returns>The <see cref="T:System.IO.Pipes.PipeTransmissionMode"></see> that is supported by the current pipe.</returns>
720 <member name="T:System.IO.Pipes.AnonymousPipeClientStream">
721 <summary>Exposes the client side of an anonymous pipe stream, which supports both synchronous and asynchronous read and write operations.</summary>
723 <member name="M:System.IO.Pipes.AnonymousPipeClientStream.#ctor(System.String)">
724 <summary>Initializes a new instance of the <see cref="T:System.IO.Pipes.AnonymousPipeClientStream"></see> class with the specified string representation of the pipe handle.</summary>
725 <param name="pipeHandleAsString">A string that represents the pipe handle.</param>
726 <exception cref="T:System.IO.IOException"><paramref name="pipeHandleAsString">pipeHandleAsString</paramref> is not a valid pipe handle.</exception>
728 <member name="M:System.IO.Pipes.AnonymousPipeClientStream.#ctor(System.IO.Pipes.PipeDirection,Microsoft.Win32.SafeHandles.SafePipeHandle)">
729 <summary>Initializes a new instance of the <see cref="T:System.IO.Pipes.AnonymousPipeClientStream"></see> class from the specified handle.</summary>
730 <param name="direction">One of the enumeration values that determines the direction of the pipe.
731 Anonymous pipes can only be in one direction, so direction cannot be set to <see cref="F:System.IO.Pipes.PipeDirection.InOut"></see>.</param>
732 <param name="safePipeHandle">A safe handle for the pipe that this <see cref="T:System.IO.Pipes.AnonymousPipeClientStream"></see> object will encapsulate.</param>
733 <exception cref="T:System.ArgumentException"><paramref name="safePipeHandle">safePipeHandle</paramref> is not a valid handle.</exception>
734 <exception cref="T:System.ArgumentNullException"><paramref name="safePipeHandle">safePipeHandle</paramref> is <see langword="null"></see>.</exception>
735 <exception cref="T:System.NotSupportedException"><paramref name="direction">direction</paramref> is set to <see cref="System.IO.Pipes.PipeDirection.InOut"></see>.</exception>
736 <exception cref="T:System.IO.IOException">An I/O error, such as a disk error, has occurred.
738 The stream has been closed.</exception>
740 <member name="M:System.IO.Pipes.AnonymousPipeClientStream.#ctor(System.IO.Pipes.PipeDirection,System.String)">
741 <summary>Initializes a new instance of the <see cref="T:System.IO.Pipes.AnonymousPipeClientStream"></see> class with the specified pipe direction and a string representation of the pipe handle.</summary>
742 <param name="direction">One of the enumeration values that determines the direction of the pipe.
743 Anonymous pipes can only be in one direction, so direction cannot be set to <see cref="F:System.IO.Pipes.PipeDirection.InOut"></see>.</param>
744 <param name="pipeHandleAsString">A string that represents the pipe handle.</param>
745 <exception cref="T:System.ArgumentException"><paramref name="pipeHandleAsString">pipeHandleAsString</paramref> is an invalid handle.</exception>
746 <exception cref="T:System.ArgumentNullException"><paramref name="pipeHandleAsString">pipeHandleAsString</paramref> is <see langword="null"></see>.</exception>
747 <exception cref="T:System.NotSupportedException"><paramref name="direction">direction</paramref> is set to <see cref="System.IO.Pipes.PipeDirection.InOut"></see>.</exception>
749 <member name="M:System.IO.Pipes.AnonymousPipeClientStream.Finalize">
750 <summary>Releases unmanaged resources and performs other cleanup operations before the <see cref="T:System.IO.Pipes.AnonymousPipeClientStream"></see> instance is reclaimed by garbage collection.</summary>
752 <member name="P:System.IO.Pipes.AnonymousPipeClientStream.ReadMode">
753 <summary>Sets the reading mode for the <see cref="T:System.IO.Pipes.AnonymousPipeClientStream"></see> object.</summary>
754 <returns>The <see cref="T:System.IO.Pipes.PipeTransmissionMode"></see> for the <see cref="T:System.IO.Pipes.AnonymousPipeClientStream"></see> object.</returns>
755 <exception cref="T:System.ArgumentOutOfRangeException">The transmission mode is not valid. For anonymous pipes, only <see cref="System.IO.Pipes.PipeTransmissionMode.Byte"></see> is supported.</exception>
756 <exception cref="T:System.NotSupportedException">The transmission mode is <see cref="System.IO.Pipes.PipeTransmissionMode.Message"></see>.</exception>
757 <exception cref="T:System.IO.IOException">The connection is broken or another I/O error occurs.</exception>
758 <exception cref="T:System.ObjectDisposedException">The pipe is closed.</exception>
760 <member name="P:System.IO.Pipes.AnonymousPipeClientStream.TransmissionMode">
761 <summary>Gets the pipe transmission mode supported by the current pipe.</summary>
762 <returns>The <see cref="T:System.IO.Pipes.PipeTransmissionMode"></see> supported by the current pipe.</returns>
764 <member name="T:Microsoft.Win32.SafeHandles.SafePipeHandle">
765 <summary>Represents a wrapper class for a pipe handle.</summary>
767 <member name="M:Microsoft.Win32.SafeHandles.SafePipeHandle.#ctor(System.IntPtr,System.Boolean)">
768 <summary>Initializes a new instance of the <see cref="T:Microsoft.Win32.SafeHandles.SafePipeHandle"></see> class.</summary>
769 <param name="preexistingHandle">An <see cref="T:System.IntPtr"></see> object that represents the pre-existing handle to use.</param>
770 <param name="ownsHandle"><see langword="true"></see> to reliably release the handle during the finalization phase; <see langword="false"></see> to prevent reliable release (not recommended).</param>
772 <member name="P:Microsoft.Win32.SafeHandles.SafePipeHandle.IsInvalid">