NamedPipeClientStream Class
Exposes a Stream around a named pipe, which supports both synchronous and asynchronous read and write operations.
System::MarshalByRefObject
System.IO::Stream
System.IO.Pipes::PipeStream
System.IO.Pipes::NamedPipeClientStream
Assembly: System.Core (in System.Core.dll)
The NamedPipeClientStream type exposes the following members.
| Name | Description | |
|---|---|---|
![]() | NamedPipeClientStream(String) | Initializes a new instance of the NamedPipeClientStream class with the specified pipe name. |
![]() | NamedPipeClientStream(String, String) | Initializes a new instance of the NamedPipeClientStream class with the specified pipe and server names. |
![]() | NamedPipeClientStream(String, String, PipeDirection) | Initializes a new instance of the NamedPipeClientStream class with the specified pipe and server names, and the specified pipe direction. |
![]() | NamedPipeClientStream(PipeDirection, Boolean, Boolean, SafePipeHandle) | Initializes a new instance of the NamedPipeClientStream class for the specified pipe handle with the specified pipe direction. |
![]() | NamedPipeClientStream(String, String, PipeDirection, PipeOptions) | Initializes a new instance of the NamedPipeClientStream class with the specified pipe and server names, and the specified pipe direction and pipe options. |
![]() | NamedPipeClientStream(String, String, PipeDirection, PipeOptions, TokenImpersonationLevel) | Initializes a new instance of the NamedPipeClientStream class with the specified pipe and server names, and the specified pipe direction, pipe options, and security impersonation level. |
![]() | NamedPipeClientStream(String, String, PipeAccessRights, PipeOptions, TokenImpersonationLevel, HandleInheritability) | Initializes a new instance of the NamedPipeClientStream class with the specified pipe and server names, and the specified pipe options, security impersonation level, and inheritability mode. |
![]() | NamedPipeClientStream(String, String, PipeDirection, PipeOptions, TokenImpersonationLevel, HandleInheritability) | Initializes a new instance of the NamedPipeClientStream class with the specified pipe and server names, and the specified pipe direction, pipe options, security impersonation level, and inheritability mode. |
| Name | Description | |
|---|---|---|
![]() | CanRead | Gets a value indicating whether the current stream supports read operations. (Inherited from PipeStream.) |
![]() | CanSeek | Gets a value indicating whether the current stream supports seek operations. (Inherited from PipeStream.) |
![]() | CanTimeout | Gets a value that determines whether the current stream can time out. (Inherited from Stream.) |
![]() | CanWrite | Gets a value indicating whether the current stream supports write operations. (Inherited from PipeStream.) |
![]() | InBufferSize | Gets the size, in bytes, of the inbound buffer for a pipe. (Inherited from PipeStream.) |
![]() | IsAsync | Gets a value indicating whether a PipeStream object was opened asynchronously or synchronously. (Inherited from PipeStream.) |
![]() | IsConnected | Gets or sets a value indicating whether a PipeStream object is connected. (Inherited from PipeStream.) |
![]() | IsHandleExposed | Gets a value indicating whether a handle to a PipeStream object is exposed. (Inherited from PipeStream.) |
![]() | IsMessageComplete | Gets a value indicating whether there is more data in the message returned from the most recent read operation. (Inherited from PipeStream.) |
![]() | Length | Gets the length of a stream, in bytes. (Inherited from PipeStream.) |
![]() | NumberOfServerInstances | Gets the number of server instances that share the same pipe name. |
![]() | OutBufferSize | Gets the size, in bytes, of the outbound buffer for a pipe. (Inherited from PipeStream.) |
![]() | Position | Gets or sets the current position of the current stream. (Inherited from PipeStream.) |
![]() | ReadMode | Gets or sets the reading mode for a PipeStream object. (Inherited from PipeStream.) |
![]() | ReadTimeout | Gets or sets a value, in miliseconds, that determines how long the stream will attempt to read before timing out. (Inherited from Stream.) |
![]() | SafePipeHandle | Gets the safe handle for the local end of the pipe that the current PipeStream object encapsulates. (Inherited from PipeStream.) |
![]() | TransmissionMode | Gets the pipe transmission mode supported by the current pipe. (Inherited from PipeStream.) |
![]() | WriteTimeout | Gets or sets a value, in miliseconds, that determines how long the stream will attempt to write before timing out. (Inherited from Stream.) |
| Name | Description | |
|---|---|---|
![]() | BeginRead | Begins an asynchronous read operation. (Inherited from PipeStream.) |
![]() | BeginWrite | Begins an asynchronous write operation. (Inherited from PipeStream.) |
![]() | CheckPipePropertyOperations | Infrastructure. Verifies that the pipe is in a proper state for getting or setting properties. (Inherited from PipeStream.) |
![]() | CheckReadOperations | Infrastructure. Verifies that the pipe is in a connected state for read operations. (Inherited from PipeStream.) |
![]() | CheckWriteOperations | Infrastructure. Verifies that the pipe is in a connected state for write operations. (Inherited from PipeStream.) |
![]() | Close | Closes the current stream and releases any resources (such as sockets and file handles) associated with the current stream. (Inherited from Stream.) |
![]() | Connect() | Connects to a waiting server with an infinite time-out value. |
![]() | Connect(Int32) | Connects to a waiting server within the specified time-out period. |
![]() | CopyTo(Stream) | Reads the bytes from the current stream and writes them to the destination stream. (Inherited from Stream.) |
![]() | CopyTo(Stream, Int32) | Reads all the bytes from the current stream and writes them to a destination stream, using a specified buffer size. (Inherited from Stream.) |
![]() | CreateObjRef | Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.) |
![]() | CreateWaitHandle | Obsolete. Allocates a WaitHandle object. (Inherited from Stream.) |
![]() | Dispose() | Releases all resources used by the Stream. (Inherited from Stream.) |
![]() | Dispose(Boolean) | Releases the unmanaged resources used by the PipeStream class and optionally releases the managed resources. (Inherited from PipeStream.) |
![]() | EndRead | Ends a pending asynchronous read request. (Inherited from PipeStream.) |
![]() | EndWrite | Ends a pending asynchronous write request. (Inherited from PipeStream.) |
![]() | Equals(Object) | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
![]() | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
![]() | Flush | Clears the buffer for the current stream and causes any buffered data to be written to the underlying device. (Inherited from PipeStream.) |
![]() | GetAccessControl | Gets a PipeSecurity object that encapsulates the access control list (ACL) entries for the pipe described by the current PipeStream object. (Inherited from PipeStream.) |
![]() | GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
![]() | GetLifetimeService | Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.) |
![]() | GetType | Gets the Type of the current instance. (Inherited from Object.) |
![]() | InitializeHandle | Initializes a PipeStream object from the specified SafePipeHandle object. (Inherited from PipeStream.) |
![]() | InitializeLifetimeService | Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.) |
![]() | MemberwiseClone() | Creates a shallow copy of the current Object. (Inherited from Object.) |
![]() | MemberwiseClone(Boolean) | Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.) |
![]() | ObjectInvariant | Infrastructure. Provides support for a Contract. (Inherited from Stream.) |
![]() | Read | Reads a block of bytes from a stream and writes the data to a specified buffer. (Inherited from PipeStream.) |
![]() | ReadByte | Reads a byte from a pipe. (Inherited from PipeStream.) |
![]() | Seek | Sets the current position of the current stream to the specified value. (Inherited from PipeStream.) |
![]() | SetAccessControl | Applies the access control list (ACL) entries specified by a PipeSecurity object to the pipe specified by the current PipeStream object. (Inherited from PipeStream.) |
![]() | SetLength | Sets the length of the current stream to the specified value. (Inherited from PipeStream.) |
![]() | ToString | Returns a string that represents the current object. (Inherited from Object.) |
![]() | WaitForPipeDrain | Waits for the other end of the pipe to read all sent bytes. (Inherited from PipeStream.) |
![]() | Write | Writes a block of bytes to the current stream using data from a buffer. (Inherited from PipeStream.) |
![]() | WriteByte | Writes a byte to the current stream. (Inherited from PipeStream.) |
Named pipes provide one-way or duplex pipes for communication between a pipe server and one or more pipe clients. Named pipes can be used for interprocess communication locally or over a network. A single pipe name can be shared by multiple NamedPipeClientStream objects.
Any process can act as either a named pipe server or client, or both.
Note |
|---|
For Windows XP Professional and Windows 2000 Server, a maximum of 10 pipes can simultaneously connect over the network. |
Note |
|---|
The HostProtectionAttribute attribute applied to this type or member has the following Resources property value: MayLeakOnAbort. The HostProtectionAttribute does not affect desktop applications (which are typically started by double-clicking an icon, typing a command, or entering a URL in a browser). For more information, see the HostProtectionAttribute class or SQL Server Programming and Host Protection Attributes. |
The following example demonstrates a way to send a string from a parent process to a child process on the same computer using named pipes. This example creates a NamedPipeServerStream object in a parent process. The NamedPipeServerStream object has a PipeDirection value of Out. The server then waits for a NamedPipeClientStream object in a child process to connect to it. In this example, both processes are on the same computer and the NamedPipeClientStream object has a PipeDirection value of In. The parent process then sends a user-supplied string to the child process. The string is displayed to the console.
This example is for the client process, which connects to the server process. For the entire code sample, including the code for both the pipe client and server, see How to: Use Named Pipes to Communicate Between Processes over a Network.
Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
