1 <?xml version="1.0" encoding="utf-8"?><span>
4 <name>System.IO.Pipes</name>
7 <member name="T:Microsoft.Win32.SafeHandles.SafePipeHandle">
8 <summary>Represents a wrapper class for a pipe handle.</summary>
10 <member name="M:Microsoft.Win32.SafeHandles.SafePipeHandle.#ctor(System.IntPtr,System.Boolean)">
11 <summary>Initializes a new instance of the <see cref="T:Microsoft.Win32.SafeHandles.SafePipeHandle"></see> class.</summary>
12 <param name="preexistingHandle">An <see cref="T:System.IntPtr"></see> object that represents the pre-existing handle to use.</param>
13 <param name="ownsHandle">true to reliably release the handle during the finalization phase; false to prevent reliable release (not recommended).</param>
15 <member name="P:Microsoft.Win32.SafeHandles.SafePipeHandle.IsInvalid">
18 <member name="T:System.IO.Pipes.AnonymousPipeClientStream">
19 <summary>Exposes the client side of an anonymous pipe stream, which supports both synchronous and asynchronous read and write operations.</summary>
21 <member name="M:System.IO.Pipes.AnonymousPipeClientStream.#ctor(System.String)">
22 <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>
23 <param name="pipeHandleAsString">A string that represents the pipe handle.</param>
24 <exception cref="T:System.IO.IOException"><paramref name="pipeHandleAsString">pipeHandleAsString</paramref> is not a valid pipe handle.</exception>
26 <member name="M:System.IO.Pipes.AnonymousPipeClientStream.#ctor(System.IO.Pipes.PipeDirection,Microsoft.Win32.SafeHandles.SafePipeHandle)">
27 <summary>Initializes a new instance of the <see cref="T:System.IO.Pipes.AnonymousPipeClientStream"></see> class from the specified handle.</summary>
28 <param name="direction">One of the enumeration values that determines the direction of the pipe. Anonymous pipes can only be in one direction, so direction cannot be set to <see cref="F:System.IO.Pipes.PipeDirection.InOut"></see>.</param>
29 <param name="safePipeHandle">A safe handle for the pipe that this <see cref="T:System.IO.Pipes.AnonymousPipeClientStream"></see> object will encapsulate.</param>
30 <exception cref="T:System.ArgumentException"><paramref name="safePipeHandle">safePipeHandle</paramref> is not a valid handle.</exception>
31 <exception cref="T:System.ArgumentNullException"><paramref name="safePipeHandle">safePipeHandle</paramref> is null.</exception>
32 <exception cref="T:System.NotSupportedException"><paramref name="direction">direction</paramref> is set to <see cref="F:System.IO.Pipes.PipeDirection.InOut"></see>.</exception>
33 <exception cref="T:System.IO.IOException">An I/O error, such as a disk error, has occurred. -or- The stream has been closed.</exception>
35 <member name="M:System.IO.Pipes.AnonymousPipeClientStream.#ctor(System.IO.Pipes.PipeDirection,System.String)">
36 <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>
37 <param name="direction">One of the enumeration values that determines the direction of the pipe. Anonymous pipes can only be in one direction, so direction cannot be set to <see cref="F:System.IO.Pipes.PipeDirection.InOut"></see>.</param>
38 <param name="pipeHandleAsString">A string that represents the pipe handle.</param>
39 <exception cref="T:System.ArgumentException"><paramref name="pipeHandleAsString">pipeHandleAsString</paramref> is an invalid handle.</exception>
40 <exception cref="T:System.ArgumentNullException"><paramref name="pipeHandleAsString">pipeHandleAsString</paramref> is null.</exception>
41 <exception cref="T:System.NotSupportedException"><paramref name="direction">direction</paramref> is set to <see cref="F:System.IO.Pipes.PipeDirection.InOut"></see>.</exception>
43 <member name="M:System.IO.Pipes.AnonymousPipeClientStream.Finalize">
44 <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>
46 <member name="P:System.IO.Pipes.AnonymousPipeClientStream.ReadMode">
47 <summary>Sets the reading mode for the <see cref="T:System.IO.Pipes.AnonymousPipeClientStream"></see> object.</summary>
48 <returns>The <see cref="T:System.IO.Pipes.PipeTransmissionMode"></see> for the <see cref="T:System.IO.Pipes.AnonymousPipeClientStream"></see> object.</returns>
49 <exception cref="T:System.ArgumentOutOfRangeException">The transmission mode is not valid. For anonymous pipes, only <see cref="F:System.IO.Pipes.PipeTransmissionMode.Byte"></see> is supported.</exception>
50 <exception cref="T:System.NotSupportedException">The transmission mode is <see cref="F:System.IO.Pipes.PipeTransmissionMode.Message"></see>.</exception>
51 <exception cref="T:System.IO.IOException">The connection is broken or another I/O error occurs.</exception>
52 <exception cref="T:System.ObjectDisposedException">The pipe is closed.</exception>
54 <member name="P:System.IO.Pipes.AnonymousPipeClientStream.TransmissionMode">
55 <summary>Gets the pipe transmission mode supported by the current pipe.</summary>
56 <returns>The <see cref="T:System.IO.Pipes.PipeTransmissionMode"></see> supported by the current pipe.</returns>
58 <member name="T:System.IO.Pipes.AnonymousPipeServerStream">
59 <summary>Exposes a stream around an anonymous pipe, which supports both synchronous and asynchronous read and write operations.</summary>
61 <member name="M:System.IO.Pipes.AnonymousPipeServerStream.#ctor">
62 <summary>Initializes a new instance of the <see cref="T:System.IO.Pipes.AnonymousPipeServerStream"></see> class.</summary>
64 <member name="M:System.IO.Pipes.AnonymousPipeServerStream.#ctor(System.IO.Pipes.PipeDirection)">
65 <summary>Initializes a new instance of the <see cref="T:System.IO.Pipes.AnonymousPipeServerStream"></see> class with the specified pipe direction.</summary>
66 <param name="direction">One of the enumeration values that determines the direction of the pipe. Anonymous pipes can only be in one direction, so direction cannot be set to <see cref="F:System.IO.Pipes.PipeDirection.InOut"></see>.</param>
67 <exception cref="T:System.NotSupportedException"><paramref name="direction">direction</paramref> is set to <see cref="F:System.IO.Pipes.PipeDirection.InOut"></see>.</exception>
69 <member name="M:System.IO.Pipes.AnonymousPipeServerStream.#ctor(System.IO.Pipes.PipeDirection,System.IO.HandleInheritability)">
70 <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>
71 <param name="direction">One of the enumeration values that determines the direction of the pipe. Anonymous pipes can only be in one direction, so direction cannot be set to <see cref="F:System.IO.Pipes.PipeDirection.InOut"></see>.</param>
72 <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>
73 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="inheritability">inheritability</paramref> is not set to either <see cref="F:System.IO.HandleInheritability.None"></see> or <see cref="F:System.IO.HandleInheritability.Inheritable"></see>.</exception>
74 <exception cref="T:System.NotSupportedException"><paramref name="direction">direction</paramref> is set to <see cref="F:System.IO.Pipes.PipeDirection.InOut"></see>.</exception>
76 <member name="M:System.IO.Pipes.AnonymousPipeServerStream.#ctor(System.IO.Pipes.PipeDirection,Microsoft.Win32.SafeHandles.SafePipeHandle,Microsoft.Win32.SafeHandles.SafePipeHandle)">
77 <summary>Initializes a new instance of the <see cref="T:System.IO.Pipes.AnonymousPipeServerStream"></see> class from the specified pipe handles.</summary>
78 <param name="direction">One of the enumeration values that determines the direction of the pipe. Anonymous pipes can only be in one direction, so direction cannot be set to <see cref="F:System.IO.Pipes.PipeDirection.InOut"></see>.</param>
79 <param name="serverSafePipeHandle">A safe handle for the pipe that this <see cref="T:System.IO.Pipes.AnonymousPipeServerStream"></see> object will encapsulate.</param>
80 <param name="clientSafePipeHandle">A safe handle for the <see cref="T:System.IO.Pipes.AnonymousPipeClientStream"></see> object.</param>
81 <exception cref="T:System.ArgumentException"><paramref name="serverSafePipeHandle">serverSafePipeHandle</paramref> or <paramref name="clientSafePipeHandle">clientSafePipeHandle</paramref> is an invalid handle.</exception>
82 <exception cref="T:System.ArgumentNullException"><paramref name="serverSafePipeHandle">serverSafePipeHandle</paramref> or <paramref name="clientSafePipeHandle">clientSafePipeHandle</paramref> is null.</exception>
83 <exception cref="T:System.NotSupportedException"><paramref name="direction">direction</paramref> is set to <see cref="F:System.IO.Pipes.PipeDirection.InOut"></see>.</exception>
84 <exception cref="T:System.IO.IOException">An I/O error, such as a disk error, has occurred. -or- The stream has been closed.</exception>
86 <member name="M:System.IO.Pipes.AnonymousPipeServerStream.#ctor(System.IO.Pipes.PipeDirection,System.IO.HandleInheritability,System.Int32)">
87 <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>
88 <param name="direction">One of the enumeration values that determines the direction of the pipe. Anonymous pipes can only be in one direction, so direction cannot be set to <see cref="F:System.IO.Pipes.PipeDirection.InOut"></see>.</param>
89 <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>
90 <param name="bufferSize">The size of the buffer. This value must be greater than or equal to 0.</param>
91 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="inheritability">inheritability</paramref> is not set to either <see cref="F:System.IO.HandleInheritability.None"></see> or <see cref="F:System.IO.HandleInheritability.Inheritable"></see>. -or- <paramref name="bufferSize">bufferSize</paramref> is less than 0.</exception>
92 <exception cref="T:System.NotSupportedException"><paramref name="direction">direction</paramref> is set to <see cref="F:System.IO.Pipes.PipeDirection.InOut"></see>.</exception>
94 <member name="P:System.IO.Pipes.AnonymousPipeServerStream.ClientSafePipeHandle">
95 <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>
96 <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>
98 <member name="M:System.IO.Pipes.AnonymousPipeServerStream.DisposeLocalCopyOfClientHandle">
99 <summary>Closes the local copy of the <see cref="T:System.IO.Pipes.AnonymousPipeClientStream"></see> object's handle.</summary>
101 <member name="M:System.IO.Pipes.AnonymousPipeServerStream.Finalize">
102 <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>
104 <member name="M:System.IO.Pipes.AnonymousPipeServerStream.GetClientHandleAsString">
105 <summary>Gets the connected <see cref="T:System.IO.Pipes.AnonymousPipeClientStream"></see> object's handle as a string.</summary>
106 <returns>A string that represents the connected <see cref="T:System.IO.Pipes.AnonymousPipeClientStream"></see> object's handle.</returns>
108 <member name="P:System.IO.Pipes.AnonymousPipeServerStream.ReadMode">
109 <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>
110 <returns>The reading mode for the <see cref="T:System.IO.Pipes.AnonymousPipeServerStream"></see> object.</returns>
111 <exception cref="T:System.ArgumentOutOfRangeException">The transmission mode is not valid. For anonymous pipes, only <see cref="F:System.IO.Pipes.PipeTransmissionMode.Byte"></see> is supported.</exception>
112 <exception cref="T:System.NotSupportedException">The property is set to <see cref="F:System.IO.Pipes.PipeTransmissionMode.Message"></see>, which is not supported for anonymous pipes.</exception>
113 <exception cref="T:System.IO.IOException">The connection is broken or another I/O error occurs.</exception>
114 <exception cref="T:System.ObjectDisposedException">The pipe is closed.</exception>
116 <member name="P:System.IO.Pipes.AnonymousPipeServerStream.TransmissionMode">
117 <summary>Gets the pipe transmission mode that is supported by the current pipe.</summary>
118 <returns>The <see cref="T:System.IO.Pipes.PipeTransmissionMode"></see> that is supported by the current pipe.</returns>
120 <member name="T:System.IO.Pipes.NamedPipeClientStream">
121 <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>
123 <member name="M:System.IO.Pipes.NamedPipeClientStream.#ctor(System.String)">
124 <summary>Initializes a new instance of the <see cref="T:System.IO.Pipes.NamedPipeClientStream"></see> class with the specified pipe name.</summary>
125 <param name="pipeName">The name of the pipe.</param>
126 <exception cref="T:System.ArgumentNullException"><paramref name="pipeName">pipeName</paramref> is null.</exception>
127 <exception cref="T:System.ArgumentException"><paramref name="pipeName">pipeName</paramref> is a zero-length string.</exception>
128 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="pipeName">pipeName</paramref> is set to "anonymous".</exception>
130 <member name="M:System.IO.Pipes.NamedPipeClientStream.#ctor(System.String,System.String)">
131 <summary>Initializes a new instance of the <see cref="T:System.IO.Pipes.NamedPipeClientStream"></see> class with the specified pipe and server names.</summary>
132 <param name="serverName">The name of the remote computer to connect to, or "." to specify the local computer.</param>
133 <param name="pipeName">The name of the pipe.</param>
134 <exception cref="T:System.ArgumentNullException"><paramref name="pipeName">pipeName</paramref> or <paramref name="serverName">serverName</paramref> is null.</exception>
135 <exception cref="T:System.ArgumentException"><paramref name="pipeName">pipeName</paramref> or <paramref name="serverName">serverName</paramref> is a zero-length string.</exception>
136 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="pipeName">pipeName</paramref> is set to "anonymous".</exception>
138 <member name="M:System.IO.Pipes.NamedPipeClientStream.#ctor(System.String,System.String,System.IO.Pipes.PipeDirection)">
139 <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>
140 <param name="serverName">The name of the remote computer to connect to, or "." to specify the local computer.</param>
141 <param name="pipeName">The name of the pipe.</param>
142 <param name="direction">One of the enumeration values that determines the direction of the pipe.</param>
143 <exception cref="T:System.ArgumentNullException"><paramref name="pipeName">pipeName</paramref> or <paramref name="serverName">serverName</paramref> is null.</exception>
144 <exception cref="T:System.ArgumentException"><paramref name="pipeName">pipeName</paramref> or <paramref name="serverName">serverName</paramref> is a zero-length string.</exception>
145 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="pipeName">pipeName</paramref> is set to "anonymous". -or- <paramref name="direction">direction</paramref> is not a valid <see cref="T:System.IO.Pipes.PipeDirection"></see> value.</exception>
147 <member name="M:System.IO.Pipes.NamedPipeClientStream.#ctor(System.IO.Pipes.PipeDirection,System.Boolean,System.Boolean,Microsoft.Win32.SafeHandles.SafePipeHandle)">
148 <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>
149 <param name="direction">One of the enumeration values that determines the direction of the pipe.</param>
150 <param name="isAsync">true to indicate that the handle was opened asynchronously; otherwise, false.</param>
151 <param name="isConnected">true to indicate that the pipe is connected; otherwise, false.</param>
152 <param name="safePipeHandle">A safe handle for the pipe that this <see cref="T:System.IO.Pipes.NamedPipeClientStream"></see> object will encapsulate.</param>
153 <exception cref="T:System.IO.IOException">The stream has been closed.</exception>
154 <exception cref="T:System.ArgumentException"><paramref name="safePipeHandle">safePipeHandle</paramref> is not a valid handle.</exception>
155 <exception cref="T:System.ArgumentNullException"><paramref name="safePipeHandle">safePipeHandle</paramref> is null.</exception>
156 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="direction">direction</paramref> is not a valid <see cref="T:System.IO.Pipes.PipeDirection"></see> value.</exception>
158 <member name="M:System.IO.Pipes.NamedPipeClientStream.#ctor(System.String,System.String,System.IO.Pipes.PipeDirection,System.IO.Pipes.PipeOptions)">
159 <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>
160 <param name="serverName">The name of the remote computer to connect to, or "." to specify the local computer.</param>
161 <param name="pipeName">The name of the pipe.</param>
162 <param name="direction">One of the enumeration values that determines the direction of the pipe.</param>
163 <param name="options">One of the enumeration values that determines how to open or create the pipe.</param>
164 <exception cref="T:System.ArgumentNullException"><paramref name="pipeName">pipeName</paramref> or <paramref name="serverName">serverName</paramref> is null.</exception>
165 <exception cref="T:System.ArgumentException"><paramref name="pipeName">pipeName</paramref> or <paramref name="serverName">serverName</paramref> is a zero-length string.</exception>
166 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="pipeName">pipeName</paramref> is set to "anonymous". -or- <paramref name="direction">direction</paramref> is not a valid <see cref="T:System.IO.Pipes.PipeDirection"></see> value. -or- <paramref name="options">options</paramref> is not a valid <see cref="T:System.IO.Pipes.PipeOptions"></see> value.</exception>
168 <member name="M:System.IO.Pipes.NamedPipeClientStream.#ctor(System.String,System.String,System.IO.Pipes.PipeDirection,System.IO.Pipes.PipeOptions,System.Security.Principal.TokenImpersonationLevel)">
169 <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>
170 <param name="serverName">The name of the remote computer to connect to, or "." to specify the local computer.</param>
171 <param name="pipeName">The name of the pipe.</param>
172 <param name="direction">One of the enumeration values that determines the direction of the pipe.</param>
173 <param name="options">One of the enumeration values that determines how to open or create the pipe.</param>
174 <param name="impersonationLevel">One of the enumeration values that determines the security impersonation level.</param>
175 <exception cref="T:System.ArgumentNullException"><paramref name="pipeName">pipeName</paramref> or <paramref name="serverName">serverName</paramref> is null.</exception>
176 <exception cref="T:System.ArgumentException"><paramref name="pipeName">pipeName</paramref> or <paramref name="serverName">serverName</paramref> is a zero-length string.</exception>
177 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="pipeName">pipeName</paramref> is set to "anonymous". -or- <paramref name="direction">direction</paramref> is not a valid <see cref="T:System.IO.Pipes.PipeDirection"></see> value. -or- <paramref name="options">options</paramref> is not a valid <see cref="T:System.IO.Pipes.PipeOptions"></see> value. -or- <paramref name="impersonationLevel">impersonationLevel</paramref> is not a valid <see cref="T:System.Security.Principal.TokenImpersonationLevel"></see> value.</exception>
179 <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)">
180 <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>
181 <param name="serverName">The name of the remote computer to connect to, or "." to specify the local computer.</param>
182 <param name="pipeName">The name of the pipe.</param>
183 <param name="direction">One of the enumeration values that determines the direction of the pipe.</param>
184 <param name="options">One of the enumeration values that determines how to open or create the pipe.</param>
185 <param name="impersonationLevel">One of the enumeration values that determines the security impersonation level.</param>
186 <param name="inheritability">One of the enumeration values that determines whether the underlying handle will be inheritable by child processes.</param>
187 <exception cref="T:System.ArgumentNullException"><paramref name="pipeName">pipeName</paramref> or <paramref name="serverName">serverName</paramref> is null.</exception>
188 <exception cref="T:System.ArgumentException"><paramref name="pipeName">pipeName</paramref> or <paramref name="serverName">serverName</paramref> is a zero-length string.</exception>
189 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="pipeName">pipeName</paramref> is set to "anonymous". -or- <paramref name="direction">direction</paramref> is not a valid <see cref="T:System.IO.Pipes.PipeDirection"></see> value. -or- <paramref name="options">options</paramref> is not a valid <see cref="T:System.IO.Pipes.PipeOptions"></see> value. -or- <paramref name="impersonationLevel">impersonationLevel</paramref> is not a valid <see cref="T:System.Security.Principal.TokenImpersonationLevel"></see> value. -or- <paramref name="inheritability">inheritability</paramref> is not a valid <see cref="T:System.IO.HandleInheritability"></see> value.</exception>
191 <member name="M:System.IO.Pipes.NamedPipeClientStream.Connect">
192 <summary>Connects to a waiting server with an infinite time-out value.</summary>
193 <exception cref="T:System.InvalidOperationException">The client is already connected.</exception>
195 <member name="M:System.IO.Pipes.NamedPipeClientStream.Connect(System.Int32)">
196 <summary>Connects to a waiting server within the specified time-out period.</summary>
197 <param name="timeout">The number of milliseconds to wait for the server to respond before the connection times out.</param>
198 <exception cref="T:System.TimeoutException">Could not connect to the server within the specified <paramref name="timeout">timeout</paramref> period.</exception>
199 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="timeout">timeout</paramref> is less than 0 and not set to <see cref="F:System.Threading.Timeout.Infinite"></see>.</exception>
200 <exception cref="T:System.InvalidOperationException">The client is already connected.</exception>
201 <exception cref="T:System.IO.IOException">The server is connected to another client and the time-out period has expired.</exception>
203 <member name="M:System.IO.Pipes.NamedPipeClientStream.ConnectAsync">
204 <summary>Asynchronously connects to a waiting server with an infinite timeout period.</summary>
205 <returns>A task that represents the asynchronous connect operation.</returns>
207 <member name="M:System.IO.Pipes.NamedPipeClientStream.ConnectAsync(System.Int32)">
208 <summary>Asynchronously connects to a waiting server within the specified timeout period.</summary>
209 <param name="timeout">The number of milliseconds to wait for the server to respond before the connection times out.</param>
210 <returns>A task that represents the asynchronous connect operation.</returns>
212 <member name="M:System.IO.Pipes.NamedPipeClientStream.ConnectAsync(System.Threading.CancellationToken)">
213 <summary>Asynchronously connects to a waiting server and monitors cancellation requests.</summary>
214 <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"></see>.</param>
215 <returns>A task that represents the asynchronous connect operation.</returns>
217 <member name="M:System.IO.Pipes.NamedPipeClientStream.ConnectAsync(System.Int32,System.Threading.CancellationToken)">
218 <summary>Asynchronously connects to a waiting server within the specified timeout period and monitors cancellation requests.</summary>
219 <param name="timeout">The number of milliseconds to wait for the server to respond before the connection times out.</param>
220 <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None"></see>.</param>
221 <returns>A task that represents the asynchronous connect operation.</returns>
223 <member name="M:System.IO.Pipes.NamedPipeClientStream.Finalize">
224 <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>
226 <member name="P:System.IO.Pipes.NamedPipeClientStream.NumberOfServerInstances">
227 <summary>Gets the number of server instances that share the same pipe name.</summary>
228 <returns>The number of server instances that share the same pipe name.</returns>
229 <exception cref="T:System.InvalidOperationException">The pipe handle has not been set. -or- The current <see cref="T:System.IO.Pipes.NamedPipeClientStream"></see> object has not yet connected to a <see cref="T:System.IO.Pipes.NamedPipeServerStream"></see> object.</exception>
230 <exception cref="T:System.IO.IOException">The pipe is broken or an I/O error occurred.</exception>
231 <exception cref="T:System.ObjectDisposedException">The underlying pipe handle is closed.</exception>
233 <member name="T:System.IO.Pipes.NamedPipeServerStream">
234 <summary>Exposes a <see cref="T:System.IO.Stream"></see> around a named pipe, supporting both synchronous and asynchronous read and write operations.</summary>
236 <member name="M:System.IO.Pipes.NamedPipeServerStream.#ctor(System.String)">
237 <summary>Initializes a new instance of the <see cref="T:System.IO.Pipes.NamedPipeServerStream"></see> class with the specified pipe name.</summary>
238 <param name="pipeName">The name of the pipe.</param>
239 <exception cref="T:System.ArgumentNullException"><paramref name="pipeName">pipeName</paramref> is null.</exception>
240 <exception cref="T:System.ArgumentException"><paramref name="pipeName">pipeName</paramref> is a zero-length string.</exception>
241 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="pipeName">pipeName</paramref> is set to "anonymous".</exception>
242 <exception cref="T:System.NotSupportedException"><paramref name="pipeName">pipeName</paramref> contains a colon (":").</exception>
243 <exception cref="T:System.PlatformNotSupportedException">The operating system is Windows Millennium Edition, Windows 98, or Windows 95, which are not supported.</exception>
244 <exception cref="T:System.IO.IOException">The maximum number of server instances has been exceeded.</exception>
246 <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)">
247 <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>
248 <param name="pipeName">The name of the pipe.</param>
249 <param name="direction">One of the enumeration values that determines the direction of the pipe.</param>
250 <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>
251 <param name="transmissionMode">One of the enumeration values that determines the transmission mode of the pipe.</param>
252 <param name="options">One of the enumeration values that determines how to open or create the pipe.</param>
253 <param name="inBufferSize">A positive value greater than 0 that indicates the input buffer size.</param>
254 <param name="outBufferSize">A positive value greater than 0 that indicates the output buffer size.</param>
255 <exception cref="T:System.ArgumentNullException"><paramref name="pipeName">pipeName</paramref> is null.</exception>
256 <exception cref="T:System.ArgumentException"><paramref name="pipeName">pipeName</paramref> is a zero-length string.</exception>
257 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="pipeName">pipeName</paramref> is set to "anonymous". -or- <paramref name="direction">direction</paramref> is not a valid <see cref="T:System.IO.Pipes.PipeDirection"></see> value. -or- <paramref name="maxNumberofServerInstances">maxNumberofServerInstances</paramref> is less than -1 or greater than 254 (-1 indicates <see cref="F:System.IO.Pipes.NamedPipeServerStream.MaxAllowedServerInstances"></see>) -or- <paramref name="options">options</paramref> is not a valid <see cref="T:System.IO.Pipes.PipeOptions"></see> value. -or- <paramref name="inBufferSize">inBufferSize</paramref> is negative.</exception>
258 <exception cref="T:System.NotSupportedException"><paramref name="pipeName">pipeName</paramref> contains a colon (":").</exception>
259 <exception cref="T:System.PlatformNotSupportedException">The operating system is Windows Millennium Edition, Windows 98, or Windows 95, which are not supported.</exception>
260 <exception cref="T:System.IO.IOException">The maximum number of server instances has been exceeded.</exception>
262 <member name="M:System.IO.Pipes.NamedPipeServerStream.#ctor(System.String,System.IO.Pipes.PipeDirection,System.Int32,System.IO.Pipes.PipeTransmissionMode,System.IO.Pipes.PipeOptions)">
263 <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>
264 <param name="pipeName">The name of the pipe.</param>
265 <param name="direction">One of the enumeration values that determines the direction of the pipe.</param>
266 <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>
267 <param name="transmissionMode">One of the enumeration values that determines the transmission mode of the pipe.</param>
268 <param name="options">One of the enumeration values that determines how to open or create the pipe.</param>
269 <exception cref="T:System.ArgumentNullException"><paramref name="pipeName">pipeName</paramref> is null.</exception>
270 <exception cref="T:System.ArgumentException"><paramref name="pipeName">pipeName</paramref> is a zero-length string.</exception>
271 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="pipeName">pipeName</paramref> is set to "anonymous". -or- <paramref name="direction">direction</paramref> is not a valid <see cref="T:System.IO.Pipes.PipeDirection"></see> value. -or- <paramref name="maxNumberofServerInstances">maxNumberofServerInstances</paramref> is less than -1 or greater than 254 (-1 indicates <see cref="F:System.IO.Pipes.NamedPipeServerStream.MaxAllowedServerInstances"></see>) -or- <paramref name="options">options</paramref> is not a valid <see cref="T:System.IO.Pipes.PipeOptions"></see> value.</exception>
272 <exception cref="T:System.NotSupportedException"><paramref name="pipeName">pipeName</paramref> contains a colon (":").</exception>
273 <exception cref="T:System.PlatformNotSupportedException">The operating system is Windows Millennium Edition, Windows 98, or Windows 95, which are not supported.</exception>
274 <exception cref="T:System.IO.IOException">The maximum number of server instances has been exceeded.</exception>
276 <member name="M:System.IO.Pipes.NamedPipeServerStream.#ctor(System.IO.Pipes.PipeDirection,System.Boolean,System.Boolean,Microsoft.Win32.SafeHandles.SafePipeHandle)">
277 <summary>Initializes a new instance of the <see cref="T:System.IO.Pipes.NamedPipeServerStream"></see> class from the specified pipe handle.</summary>
278 <param name="direction">One of the enumeration values that determines the direction of the pipe.</param>
279 <param name="isAsync">true to indicate that the handle was opened asynchronously; otherwise, false.</param>
280 <param name="isConnected">true to indicate that the pipe is connected; otherwise, false.</param>
281 <param name="safePipeHandle">A safe handle for the pipe that this <see cref="T:System.IO.Pipes.NamedPipeServerStream"></see> object will encapsulate.</param>
282 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="direction">direction</paramref> is not a valid <see cref="T:System.IO.Pipes.PipeDirection"></see> value.</exception>
283 <exception cref="T:System.ArgumentNullException"><paramref name="safePipeHandle">safePipeHandle</paramref> is null.</exception>
284 <exception cref="T:System.ArgumentException"><paramref name="safePipeHandle">safePipeHandle</paramref> is an invalid handle.</exception>
285 <exception cref="T:System.IO.IOException"><paramref name="safePipeHandle">safePipeHandle</paramref> is not a valid pipe handle. -or- The maximum number of server instances has been exceeded.</exception>
287 <member name="M:System.IO.Pipes.NamedPipeServerStream.#ctor(System.String,System.IO.Pipes.PipeDirection,System.Int32)">
288 <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>
289 <param name="pipeName">The name of the pipe.</param>
290 <param name="direction">One of the enumeration values that determines the direction of the pipe.</param>
291 <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>
292 <exception cref="T:System.ArgumentNullException"><paramref name="pipeName">pipeName</paramref> is null.</exception>
293 <exception cref="T:System.ArgumentException"><paramref name="pipeName">pipeName</paramref> is a zero-length string.</exception>
294 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="pipeName">pipeName</paramref> is set to "anonymous". -or- <paramref name="direction">direction</paramref> is not a valid <see cref="T:System.IO.Pipes.PipeDirection"></see> value. -or- A non-negative number is required. -or- <paramref name="maxNumberofServerInstances">maxNumberofServerInstances</paramref> is less than -1 or greater than 254 (-1 indicates <see cref="F:System.IO.Pipes.NamedPipeServerStream.MaxAllowedServerInstances"></see>) -or- <see cref="F:System.IO.HandleInheritability.None"></see> or <see cref="F:System.IO.HandleInheritability.Inheritable"></see> is required. -or- Access rights is limited to the <see cref="F:System.IO.Pipes.PipeAccessRights.ChangePermissions"></see> , <see cref="F:System.IO.Pipes.PipeAccessRights.TakeOwnership"></see> , and <see cref="F:System.IO.Pipes.PipeAccessRights.AccessSystemSecurity"></see> flags.</exception>
295 <exception cref="T:System.NotSupportedException"><paramref name="pipeName">pipeName</paramref> contains a colon (":").</exception>
296 <exception cref="T:System.PlatformNotSupportedException">The operating system is Windows Millennium Edition, Windows 98, or Windows 95, which are not supported.</exception>
297 <exception cref="T:System.IO.IOException">The maximum number of server instances has been exceeded.</exception>
299 <member name="M:System.IO.Pipes.NamedPipeServerStream.#ctor(System.String,System.IO.Pipes.PipeDirection)">
300 <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>
301 <param name="pipeName">The name of the pipe.</param>
302 <param name="direction">One of the enumeration values that determines the direction of the pipe.</param>
303 <exception cref="T:System.ArgumentNullException"><paramref name="pipeName">pipeName</paramref> is null.</exception>
304 <exception cref="T:System.ArgumentException"><paramref name="pipeName">pipeName</paramref> is a zero-length string.</exception>
305 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="pipeName">pipeName</paramref> is set to "anonymous". -or- <paramref name="direction">direction</paramref> is not a valid <see cref="T:System.IO.Pipes.PipeDirection"></see> value.</exception>
306 <exception cref="T:System.NotSupportedException"><paramref name="pipeName">pipeName</paramref> contains a colon (":").</exception>
307 <exception cref="T:System.PlatformNotSupportedException">The operating system is Windows Millennium Edition, Windows 98, or Windows 95, which are not supported.</exception>
308 <exception cref="T:System.IO.IOException">The maximum number of server instances has been exceeded.</exception>
310 <member name="M:System.IO.Pipes.NamedPipeServerStream.#ctor(System.String,System.IO.Pipes.PipeDirection,System.Int32,System.IO.Pipes.PipeTransmissionMode)">
311 <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>
312 <param name="pipeName">The name of the pipe.</param>
313 <param name="direction">One of the enumeration values that determines the direction of the pipe.</param>
314 <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>
315 <param name="transmissionMode">One of the enumeration values that determines the transmission mode of the pipe.</param>
316 <exception cref="T:System.ArgumentNullException"><paramref name="pipeName">pipeName</paramref> is null.</exception>
317 <exception cref="T:System.ArgumentException"><paramref name="pipeName">pipeName</paramref> is a zero-length string.</exception>
318 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="pipeName">pipeName</paramref> is set to "anonymous". -or- <paramref name="direction">direction</paramref> is not a valid <see cref="T:System.IO.Pipes.PipeDirection"></see> value. -or- <paramref name="maxNumberofServerInstances">maxNumberofServerInstances</paramref> is less than -1 or greater than 254 (-1 indicates <see cref="F:System.IO.Pipes.NamedPipeServerStream.MaxAllowedServerInstances"></see>)</exception>
319 <exception cref="T:System.NotSupportedException"><paramref name="pipeName">pipeName</paramref> contains a colon (":").</exception>
320 <exception cref="T:System.PlatformNotSupportedException">The operating system is Windows Millennium Edition, Windows 98, or Windows 95, which are not supported.</exception>
321 <exception cref="T:System.IO.IOException">The maximum number of server instances has been exceeded.</exception>
323 <member name="M:System.IO.Pipes.NamedPipeServerStream.BeginWaitForConnection(System.AsyncCallback,System.Object)">
324 <summary>Begins an asynchronous operation to wait for a client to connect.</summary>
325 <param name="callback">The method to call when a client connects to the <see cref="T:System.IO.Pipes.NamedPipeServerStream"></see> object.</param>
326 <param name="state">A user-provided object that distinguishes this particular asynchronous request from other requests.</param>
327 <returns>An object that references the asynchronous request.</returns>
328 <exception cref="T:System.InvalidOperationException">The pipe was not opened asynchronously. -or- A pipe connection has already been established. -or- The pipe handle has not been set.</exception>
329 <exception cref="T:System.IO.IOException">The pipe connection has been broken.</exception>
330 <exception cref="T:System.ObjectDisposedException">The pipe is closed.</exception>
332 <member name="M:System.IO.Pipes.NamedPipeServerStream.Disconnect">
333 <summary>Disconnects the current connection.</summary>
334 <exception cref="T:System.InvalidOperationException">No pipe connections have been made yet. -or- The connected pipe has already disconnected. -or- The pipe handle has not been set.</exception>
335 <exception cref="T:System.ObjectDisposedException">The pipe is closed.</exception>
337 <member name="M:System.IO.Pipes.NamedPipeServerStream.EndWaitForConnection(System.IAsyncResult)">
338 <summary>Ends an asynchronous operation to wait for a client to connect.</summary>
339 <param name="asyncResult">The pending asynchronous request.</param>
340 <exception cref="T:System.ArgumentNullException"><paramref name="asyncResult">asyncResult</paramref> is null.</exception>
341 <exception cref="T:System.InvalidOperationException">The pipe was not opened asynchronously. -or- The pipe handle has not been set.</exception>
342 <exception cref="T:System.IO.IOException">The pipe connection has been broken.</exception>
343 <exception cref="T:System.ObjectDisposedException">The pipe is closed.</exception>
345 <member name="M:System.IO.Pipes.NamedPipeServerStream.Finalize">
346 <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>
348 <member name="M:System.IO.Pipes.NamedPipeServerStream.GetImpersonationUserName">
349 <summary>Gets the user name of the client on the other end of the pipe.</summary>
350 <returns>The user name of the client on the other end of the pipe.</returns>
351 <exception cref="T:System.InvalidOperationException">No pipe connections have been made yet. -or- The connected pipe has already disconnected. -or- The pipe handle has not been set.</exception>
352 <exception cref="T:System.ObjectDisposedException">The pipe is closed.</exception>
353 <exception cref="T:System.IO.IOException">The pipe connection has been broken. -or- The user name of the client is longer than 19 characters.</exception>
355 <member name="F:System.IO.Pipes.NamedPipeServerStream.MaxAllowedServerInstances">
356 <summary>Represents the maximum number of server instances that the system resources allow.</summary>
359 <member name="M:System.IO.Pipes.NamedPipeServerStream.RunAsClient(System.IO.Pipes.PipeStreamImpersonationWorker)">
360 <summary>Calls a delegate while impersonating the client.</summary>
361 <param name="impersonationWorker">The delegate that specifies a method to call.</param>
362 <exception cref="T:System.InvalidOperationException">No pipe connections have been made yet. -or- The connected pipe has already disconnected. -or- The pipe handle has not been set.</exception>
363 <exception cref="T:System.ObjectDisposedException">The pipe is closed.</exception>
364 <exception cref="T:System.IO.IOException">The pipe connection has been broken. -or- An I/O error occurred.</exception>
366 <member name="M:System.IO.Pipes.NamedPipeServerStream.WaitForConnection">
367 <summary>Waits for a client to connect to this <see cref="T:System.IO.Pipes.NamedPipeServerStream"></see> object.</summary>
368 <exception cref="T:System.InvalidOperationException">A pipe connection has already been established. -or- The pipe handle has not been set.</exception>
369 <exception cref="T:System.ObjectDisposedException">The pipe is closed.</exception>
370 <exception cref="T:System.IO.IOException">The pipe connection has been broken.</exception>
372 <member name="M:System.IO.Pipes.NamedPipeServerStream.WaitForConnectionAsync">
373 <summary>Asynchronously waits for a client to connect to this <see cref="T:System.IO.Pipes.NamedPipeServerStream"></see> object.</summary>
374 <returns>A task that represents the asynchronous wait operation.</returns>
376 <member name="M:System.IO.Pipes.NamedPipeServerStream.WaitForConnectionAsync(System.Threading.CancellationToken)">
377 <summary>Asynchronously waits for a client to connect to this <see cref="T:System.IO.Pipes.NamedPipeServerStream"></see> object and monitors cancellation requests.</summary>
378 <param name="cancellationToken">The token to monitor for cancellation requests.</param>
379 <returns>A task that represents the asynchronous wait operation.</returns>
381 <member name="T:System.IO.Pipes.PipeDirection">
382 <summary>Specifies the direction of the pipe.</summary>
384 <member name="F:System.IO.Pipes.PipeDirection.In">
385 <summary>Specifies that the pipe direction is in.</summary>
388 <member name="F:System.IO.Pipes.PipeDirection.InOut">
389 <summary>Specifies that the pipe direction is two-way.</summary>
392 <member name="F:System.IO.Pipes.PipeDirection.Out">
393 <summary>Specifies that the pipe direction is out.</summary>
396 <member name="T:System.IO.Pipes.PipeOptions">
397 <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>
399 <member name="F:System.IO.Pipes.PipeOptions.Asynchronous">
400 <summary>Indicates that the pipe can be used for asynchronous reading and writing.</summary>
403 <member name="F:System.IO.Pipes.PipeOptions.None">
404 <summary>Indicates that there are no additional parameters.</summary>
407 <member name="F:System.IO.Pipes.PipeOptions.WriteThrough">
408 <summary>Indicates that the system should write through any intermediate cache and go directly to the pipe.</summary>
411 <member name="T:System.IO.Pipes.PipeStream">
412 <summary>Exposes a <see cref="T:System.IO.Stream"></see> object around a pipe, which supports both anonymous and named pipes.</summary>
414 <member name="M:System.IO.Pipes.PipeStream.#ctor(System.IO.Pipes.PipeDirection,System.Int32)">
415 <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>
416 <param name="direction">One of the <see cref="T:System.IO.Pipes.PipeDirection"></see> values that indicates the direction of the pipe object.</param>
417 <param name="bufferSize">A positive <see cref="T:System.Int32"></see> value greater than or equal to 0 that indicates the buffer size.</param>
418 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="direction">direction</paramref> is not a valid <see cref="T:System.IO.Pipes.PipeDirection"></see> value. -or- <paramref name="bufferSize">bufferSize</paramref> is less than 0.</exception>
420 <member name="M:System.IO.Pipes.PipeStream.#ctor(System.IO.Pipes.PipeDirection,System.IO.Pipes.PipeTransmissionMode,System.Int32)">
421 <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>
422 <param name="direction">One of the <see cref="T:System.IO.Pipes.PipeDirection"></see> values that indicates the direction of the pipe object.</param>
423 <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>
424 <param name="outBufferSize">A positive <see cref="T:System.Int32"></see> value greater than or equal to 0 that indicates the buffer size.</param>
425 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="direction">direction</paramref> is not a valid <see cref="T:System.IO.Pipes.PipeDirection"></see> value. -or- <paramref name="transmissionMode">transmissionMode</paramref> is not a valid <see cref="T:System.IO.Pipes.PipeTransmissionMode"></see> value. -or- <paramref name="bufferSize">bufferSize</paramref> is less than 0.</exception>
427 <member name="M:System.IO.Pipes.PipeStream.BeginRead(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object)">
428 <summary>Begins an asynchronous read operation.</summary>
429 <param name="buffer">The buffer to read data into.</param>
430 <param name="offset">The byte offset in buffer at which to begin reading.</param>
431 <param name="count">The maximum number of bytes to read.</param>
432 <param name="callback">The method to call when the asynchronous read operation is completed.</param>
433 <param name="state">A user-provided object that distinguishes this particular asynchronous read request from other requests.</param>
434 <returns>An <see cref="T:System.IAsyncResult"></see> object that references the asynchronous read.</returns>
435 <exception cref="T:System.ArgumentNullException"><paramref name="buffer">buffer</paramref> is null.</exception>
436 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="offset">offset</paramref> is less than 0. -or- <paramref name="count">count</paramref> is less than 0.</exception>
437 <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>
438 <exception cref="T:System.ObjectDisposedException">The pipe is closed.</exception>
439 <exception cref="T:System.NotSupportedException">The pipe does not support read operations.</exception>
440 <exception cref="T:System.InvalidOperationException">The pipe is disconnected, waiting to connect, or the handle has not been set.</exception>
441 <exception cref="T:System.IO.IOException">The pipe is broken or another I/O error occurred.</exception>
443 <member name="M:System.IO.Pipes.PipeStream.BeginWrite(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object)">
444 <summary>Begins an asynchronous write operation.</summary>
445 <param name="buffer">The buffer that contains the data to write to the current stream.</param>
446 <param name="offset">The zero-based byte offset in buffer at which to begin copying bytes to the current stream.</param>
447 <param name="count">The maximum number of bytes to write.</param>
448 <param name="callback">The method to call when the asynchronous write operation is completed.</param>
449 <param name="state">A user-provided object that distinguishes this particular asynchronous write request from other requests.</param>
450 <returns>An <see cref="T:System.IAsyncResult"></see> object that references the asynchronous write operation.</returns>
451 <exception cref="T:System.ArgumentNullException"><paramref name="buffer">buffer</paramref> is null.</exception>
452 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="offset">offset</paramref> is less than 0. -or- <paramref name="count">count</paramref> is less than 0.</exception>
453 <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>
454 <exception cref="T:System.ObjectDisposedException">The pipe is closed.</exception>
455 <exception cref="T:System.NotSupportedException">The pipe does not support write operations.</exception>
456 <exception cref="T:System.InvalidOperationException">The pipe is disconnected, waiting to connect, or the handle has not been set.</exception>
457 <exception cref="T:System.IO.IOException">The pipe is broken or another I/O error occurred.</exception>
459 <member name="P:System.IO.Pipes.PipeStream.CanRead">
460 <summary>Gets a value indicating whether the current stream supports read operations.</summary>
461 <returns>true if the stream supports read operations; otherwise, false.</returns>
463 <member name="P:System.IO.Pipes.PipeStream.CanSeek">
464 <summary>Gets a value indicating whether the current stream supports seek operations.</summary>
465 <returns>false in all cases.</returns>
467 <member name="P:System.IO.Pipes.PipeStream.CanWrite">
468 <summary>Gets a value indicating whether the current stream supports write operations.</summary>
469 <returns>true if the stream supports write operations; otherwise, false.</returns>
471 <member name="M:System.IO.Pipes.PipeStream.CheckPipePropertyOperations">
472 <summary>Verifies that the pipe is in a proper state for getting or setting properties.</summary>
474 <member name="M:System.IO.Pipes.PipeStream.CheckReadOperations">
475 <summary>Verifies that the pipe is in a connected state for read operations.</summary>
477 <member name="M:System.IO.Pipes.PipeStream.CheckWriteOperations">
478 <summary>Verifies that the pipe is in a connected state for write operations.</summary>
480 <member name="M:System.IO.Pipes.PipeStream.Dispose(System.Boolean)">
481 <summary>Releases the unmanaged resources used by the <see cref="T:System.IO.Pipes.PipeStream"></see> class and optionally releases the managed resources.</summary>
482 <param name="disposing">true to release both managed and unmanaged resources; false to release only unmanaged resources.</param>
484 <member name="M:System.IO.Pipes.PipeStream.EndRead(System.IAsyncResult)">
485 <summary>Ends a pending asynchronous read request.</summary>
486 <param name="asyncResult">The reference to the pending asynchronous request.</param>
487 <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>
488 <exception cref="T:System.ArgumentNullException"><paramref name="asyncResult">asyncResult</paramref> is null.</exception>
489 <exception cref="T:System.ArgumentException"><paramref name="asyncResult">asyncResult</paramref> did not originate from a <see cref="M:System.IO.Pipes.PipeStream.BeginRead(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object)"></see> method on the current stream.</exception>
490 <exception cref="T:System.IO.IOException">The stream is closed or an internal error has occurred.</exception>
492 <member name="M:System.IO.Pipes.PipeStream.EndWrite(System.IAsyncResult)">
493 <summary>Ends a pending asynchronous write request.</summary>
494 <param name="asyncResult">The reference to the pending asynchronous request.</param>
495 <exception cref="T:System.ArgumentNullException"><paramref name="asyncResult">asyncResult</paramref> is null.</exception>
496 <exception cref="T:System.ArgumentException"><paramref name="asyncResult">asyncResult</paramref> did not originate from a <see cref="M:System.IO.Pipes.PipeStream.BeginWrite(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object)"></see> method on the current stream.</exception>
497 <exception cref="T:System.IO.IOException">The stream is closed or an internal error has occurred.</exception>
499 <member name="M:System.IO.Pipes.PipeStream.Flush">
500 <summary>Clears the buffer for the current stream and causes any buffered data to be written to the underlying device.</summary>
501 <exception cref="T:System.ObjectDisposedException">The pipe is closed.</exception>
502 <exception cref="T:System.NotSupportedException">The pipe does not support write operations.</exception>
503 <exception cref="T:System.IO.IOException">The pipe is broken or another I/O error occurred.</exception>
505 <member name="P:System.IO.Pipes.PipeStream.InBufferSize">
506 <summary>Gets the size, in bytes, of the inbound buffer for a pipe.</summary>
507 <returns>An integer value that represents the inbound buffer size, in bytes.</returns>
508 <exception cref="T:System.NotSupportedException">The stream is unreadable.</exception>
509 <exception cref="T:System.InvalidOperationException">The pipe is waiting to connect.</exception>
510 <exception cref="T:System.IO.IOException">The pipe is broken or another I/O error occurred.</exception>
512 <member name="M:System.IO.Pipes.PipeStream.InitializeHandle(Microsoft.Win32.SafeHandles.SafePipeHandle,System.Boolean,System.Boolean)">
513 <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>
514 <param name="handle">The <see cref="T:Microsoft.Win32.SafeHandles.SafePipeHandle"></see> object of the pipe to initialize.</param>
515 <param name="isExposed">true to expose the handle; otherwise, false.</param>
516 <param name="isAsync">true to indicate that the handle was opened asynchronously; otherwise, false.</param>
517 <exception cref="T:System.IO.IOException">A handle cannot be bound to the pipe.</exception>
519 <member name="P:System.IO.Pipes.PipeStream.IsAsync">
520 <summary>Gets a value indicating whether a <see cref="T:System.IO.Pipes.PipeStream"></see> object was opened asynchronously or synchronously.</summary>
521 <returns>true if the <see cref="T:System.IO.Pipes.PipeStream"></see> object was opened asynchronously; otherwise, false.</returns>
523 <member name="P:System.IO.Pipes.PipeStream.IsConnected">
524 <summary>Gets or sets a value indicating whether a <see cref="T:System.IO.Pipes.PipeStream"></see> object is connected.</summary>
525 <returns>true if the <see cref="T:System.IO.Pipes.PipeStream"></see> object is connected; otherwise, false.</returns>
527 <member name="P:System.IO.Pipes.PipeStream.IsHandleExposed">
528 <summary>Gets a value indicating whether a handle to a <see cref="T:System.IO.Pipes.PipeStream"></see> object is exposed.</summary>
529 <returns>true if a handle to the <see cref="T:System.IO.Pipes.PipeStream"></see> object is exposed; otherwise, false.</returns>
531 <member name="P:System.IO.Pipes.PipeStream.IsMessageComplete">
532 <summary>Gets a value indicating whether there is more data in the message returned from the most recent read operation.</summary>
533 <returns>true if there are no more characters to read in the message; otherwise, false.</returns>
534 <exception cref="T:System.InvalidOperationException">The pipe is not connected. -or- The pipe handle has not been set. -or- The pipe's <see cref="P:System.IO.Pipes.PipeStream.ReadMode"></see> property value is not <see cref="F:System.IO.Pipes.PipeTransmissionMode.Message"></see>.</exception>
535 <exception cref="T:System.ObjectDisposedException">The pipe is closed.</exception>
537 <member name="P:System.IO.Pipes.PipeStream.Length">
538 <summary>Gets the length of a stream, in bytes.</summary>
539 <returns>0 in all cases.</returns>
540 <exception cref="T:System.NotSupportedException">Always thrown.</exception>
542 <member name="P:System.IO.Pipes.PipeStream.OutBufferSize">
543 <summary>Gets the size, in bytes, of the outbound buffer for a pipe.</summary>
544 <returns>The outbound buffer size, in bytes.</returns>
545 <exception cref="T:System.NotSupportedException">The stream is unwriteable.</exception>
546 <exception cref="T:System.InvalidOperationException">The pipe is waiting to connect.</exception>
547 <exception cref="T:System.IO.IOException">The pipe is broken or another I/O error occurred.</exception>
549 <member name="P:System.IO.Pipes.PipeStream.Position">
550 <summary>Gets or sets the current position of the current stream.</summary>
551 <returns>0 in all cases.</returns>
552 <exception cref="T:System.NotSupportedException">Always thrown.</exception>
554 <member name="M:System.IO.Pipes.PipeStream.Read(System.Byte[],System.Int32,System.Int32)">
555 <summary>Reads a block of bytes from a stream and writes the data to a specified buffer.</summary>
556 <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>
557 <param name="offset">The byte offset in the buffer array at which the bytes that are read will be placed.</param>
558 <param name="count">The maximum number of bytes to read.</param>
559 <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>
560 <exception cref="T:System.ArgumentNullException"><paramref name="buffer">buffer</paramref> is null.</exception>
561 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="offset">offset</paramref> is less than 0. -or- <paramref name="count">count</paramref> is less than 0.</exception>
562 <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>
563 <exception cref="T:System.ObjectDisposedException">The pipe is closed.</exception>
564 <exception cref="T:System.NotSupportedException">The pipe does not support read operations.</exception>
565 <exception cref="T:System.InvalidOperationException">The pipe is disconnected, waiting to connect, or the handle has not been set.</exception>
566 <exception cref="T:System.IO.IOException">Any I/O error occurred.</exception>
568 <member name="M:System.IO.Pipes.PipeStream.ReadAsync(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
569 <param name="buffer"></param>
570 <param name="offset"></param>
571 <param name="count"></param>
572 <param name="cancellationToken"></param>
575 <member name="M:System.IO.Pipes.PipeStream.ReadByte">
576 <summary>Reads a byte from a pipe.</summary>
577 <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>
578 <exception cref="T:System.ObjectDisposedException">The pipe is closed.</exception>
579 <exception cref="T:System.NotSupportedException">The pipe does not support read operations.</exception>
580 <exception cref="T:System.InvalidOperationException">The pipe is disconnected, waiting to connect, or the handle has not been set.</exception>
581 <exception cref="T:System.IO.IOException">Any I/O error occurred.</exception>
583 <member name="P:System.IO.Pipes.PipeStream.ReadMode">
584 <summary>Gets or sets the reading mode for a <see cref="T:System.IO.Pipes.PipeStream"></see> object.</summary>
585 <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>
586 <exception cref="T:System.ArgumentOutOfRangeException">The supplied value is not a valid <see cref="T:System.IO.Pipes.PipeTransmissionMode"></see> value.</exception>
587 <exception cref="T:System.NotSupportedException">The supplied value is not a supported <see cref="T:System.IO.Pipes.PipeTransmissionMode"></see> value for this pipe stream.</exception>
588 <exception cref="T:System.InvalidOperationException">The handle has not been set. -or- The pipe is waiting to connect with a named client.</exception>
589 <exception cref="T:System.IO.IOException">The pipe is broken or an I/O error occurred with a named client.</exception>
591 <member name="P:System.IO.Pipes.PipeStream.SafePipeHandle">
592 <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>
593 <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>
594 <exception cref="T:System.InvalidOperationException">The pipe handle has not been set.</exception>
595 <exception cref="T:System.ObjectDisposedException">The pipe is closed.</exception>
597 <member name="M:System.IO.Pipes.PipeStream.Seek(System.Int64,System.IO.SeekOrigin)">
598 <summary>Sets the current position of the current stream to the specified value.</summary>
599 <param name="offset">The point, relative to origin, to begin seeking from.</param>
600 <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>
601 <returns>The new position in the stream.</returns>
603 <member name="M:System.IO.Pipes.PipeStream.SetLength(System.Int64)">
604 <summary>Sets the length of the current stream to the specified value.</summary>
605 <param name="value">The new length of the stream.</param>
607 <member name="P:System.IO.Pipes.PipeStream.TransmissionMode">
608 <summary>Gets the pipe transmission mode supported by the current pipe.</summary>
609 <returns>One of the <see cref="T:System.IO.Pipes.PipeTransmissionMode"></see> values that indicates the transmission mode supported by the current pipe.</returns>
610 <exception cref="T:System.ObjectDisposedException">The pipe is closed.</exception>
611 <exception cref="T:System.InvalidOperationException">The handle has not been set. -or- The pipe is waiting to connect in an anonymous client/server operation or with a named client.</exception>
612 <exception cref="T:System.IO.IOException">The pipe is broken or another I/O error occurred.</exception>
614 <member name="M:System.IO.Pipes.PipeStream.WaitForPipeDrain">
615 <summary>Waits for the other end of the pipe to read all sent bytes.</summary>
616 <exception cref="T:System.ObjectDisposedException">The pipe is closed.</exception>
617 <exception cref="T:System.NotSupportedException">The pipe does not support write operations.</exception>
618 <exception cref="T:System.IO.IOException">The pipe is broken or another I/O error occurred.</exception>
620 <member name="M:System.IO.Pipes.PipeStream.Write(System.Byte[],System.Int32,System.Int32)">
621 <summary>Writes a block of bytes to the current stream using data from a buffer.</summary>
622 <param name="buffer">The buffer that contains data to write to the pipe.</param>
623 <param name="offset">The zero-based byte offset in buffer at which to begin copying bytes to the current stream.</param>
624 <param name="count">The maximum number of bytes to write to the current stream.</param>
625 <exception cref="T:System.ArgumentNullException"><paramref name="buffer">buffer</paramref> is null.</exception>
626 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="offset">offset</paramref> is less than 0. -or- <paramref name="count">count</paramref> is less than 0.</exception>
627 <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>
628 <exception cref="T:System.ObjectDisposedException">The pipe is closed.</exception>
629 <exception cref="T:System.NotSupportedException">The pipe does not support write operations.</exception>
630 <exception cref="T:System.IO.IOException">The pipe is broken or another I/O error occurred.</exception>
632 <member name="M:System.IO.Pipes.PipeStream.WriteAsync(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
633 <param name="buffer"></param>
634 <param name="offset"></param>
635 <param name="count"></param>
636 <param name="cancellationToken"></param>
639 <member name="M:System.IO.Pipes.PipeStream.WriteByte(System.Byte)">
640 <summary>Writes a byte to the current stream.</summary>
641 <param name="value">The byte to write to the stream.</param>
642 <exception cref="T:System.ObjectDisposedException">The pipe is closed.</exception>
643 <exception cref="T:System.NotSupportedException">The pipe does not support write operations.</exception>
644 <exception cref="T:System.InvalidOperationException">The pipe is disconnected, waiting to connect, or the handle has not been set.</exception>
645 <exception cref="T:System.IO.IOException">The pipe is broken or another I/O error occurred.</exception>
647 <member name="T:System.IO.Pipes.PipeStreamImpersonationWorker">
648 <summary>Represents the method to call as the client.</summary>
650 <member name="T:System.IO.Pipes.PipeTransmissionMode">
651 <summary>Specifies the transmission mode of the pipe.</summary>
653 <member name="F:System.IO.Pipes.PipeTransmissionMode.Byte">
654 <summary>Indicates that data in the pipe is transmitted and read as a stream of bytes.</summary>
657 <member name="F:System.IO.Pipes.PipeTransmissionMode.Message">
658 <summary>Indicates that data in the pipe is transmitted and read as a stream of messages.</summary>