mscorlib(4.0.0.0) API with additions
System.IO.Pipes Namespace Reference

Classes

class  AnonymousPipeClientStream
 Exposes the client side of an anonymous pipe stream, which supports both synchronous and asynchronous read and write operations. More...
 
class  AnonymousPipeServerStream
 Exposes a stream around an anonymous pipe, which supports both synchronous and asynchronous read and write operations. More...
 
class  NamedPipeClientStream
 Exposes a T:System.IO.Stream around a named pipe, which supports both synchronous and asynchronous read and write operations. More...
 
class  NamedPipeServerStream
 Exposes a T:System.IO.Stream around a named pipe, supporting both synchronous and asynchronous read and write operations. More...
 
class  PipeAccessRule
 Represents an abstraction of an access control entry (ACE) that defines an access rule for a pipe. More...
 
class  PipeAuditRule
 Represents an abstraction of an access control entry (ACE) that defines an audit rule for a pipe. More...
 
class  PipeSecurity
 Represents the access control and audit security for a pipe. More...
 
class  PipeStream
 Exposes a T:System.IO.Stream object around a pipe, which supports both anonymous and named pipes. More...
 

Enumerations

enum  PipeAccessRights {
  PipeAccessRights.ReadData = 0x1, PipeAccessRights.WriteData = 0x2, PipeAccessRights.ReadAttributes = 0x80, PipeAccessRights.WriteAttributes = 0x100,
  PipeAccessRights.ReadExtendedAttributes = 0x8, PipeAccessRights.WriteExtendedAttributes = 0x10, PipeAccessRights.CreateNewInstance = 0x4, PipeAccessRights.Delete = 0x10000,
  PipeAccessRights.ReadPermissions = 0x20000, PipeAccessRights.ChangePermissions = 0x40000, PipeAccessRights.TakeOwnership = 0x80000, PipeAccessRights.Synchronize = 0x100000,
  PipeAccessRights.FullControl = 0x1F019F, PipeAccessRights.Read = 0x20089, PipeAccessRights.Write = 0x112, PipeAccessRights.ReadWrite = 0x2019B,
  PipeAccessRights.AccessSystemSecurity = 0x1000000
}
 Defines the access rights to use when you create access and audit rules. More...
 
enum  PipeDirection { PipeDirection.In = 1, PipeDirection.Out, PipeDirection.InOut }
 Specifies the direction of the pipe. More...
 
enum  PipeOptions { PipeOptions.None = 0x0, PipeOptions.WriteThrough = int.MinValue, PipeOptions.Asynchronous = 0x40000000 }
 Provides options for creating a T:System.IO.Pipes.PipeStream object. This enumeration has a T:System.FlagsAttribute attribute that allows a bitwise combination of its member values. More...
 
enum  PipeState {
  WaitingToConnect, Connected, Broken, Disconnected,
  Closed
}
 
enum  PipeTransmissionMode { PipeTransmissionMode.Byte, PipeTransmissionMode.Message }
 Specifies the transmission mode of the pipe. More...
 

Functions

delegate void PipeStreamImpersonationWorker ()
 Represents the method to call as the client. More...
 

Enumeration Type Documentation

◆ PipeAccessRights

Defines the access rights to use when you create access and audit rules.

Enumerator
ReadData 

Specifies the right to read data from the pipe. This does not include the right to read file system attributes, extended file system attributes, or access and audit rules.

WriteData 

Specifies the right to write data to a pipe. This does not include the right to write file system attributes or extended file system attributes.

ReadAttributes 

Specifies the right to read file system attributes from a pipe. This does not include the right to read data, extended file system attributes, or access and audit rules.

WriteAttributes 

Specifies the right to write file system attributes to a pipe. This does not include the right to write data or extended file system attributes.

ReadExtendedAttributes 

Specifies the right to read extended file system attributes from a pipe. This does not include the right to read data, file system attributes, or access and audit rules.

WriteExtendedAttributes 

Specifies the right to write extended file system attributes to a pipe. This does not include the right to write file attributes or data.

CreateNewInstance 

Specifies the right to create a new pipe. Setting this right also sets the F:System.IO.Pipes.PipeAccessRights.Synchronize right.

Delete 

Specifies the right to delete a pipe.

ReadPermissions 

Specifies the right to read access and audit rules from the pipe. This does not include the right to read data, file system attributes, or extended file system attributes.

ChangePermissions 

Specifies the right to change the security and audit rules that are associated with a pipe.

TakeOwnership 

Specifies the right to change the owner of a pipe. Note that owners of a pipe have full access to that resource.

Synchronize 

Specifies whether the application can wait for a pipe handle to synchronize with the completion of an I/O operation.

FullControl 

Specifies the right to exert full control over a pipe, and to modify access control and audit rules. This value represents the combination of all rights in this enumeration.

Read 

Specifies the right to read from the pipe. This right includes the F:System.IO.Pipes.PipeAccessRights.ReadAttributes, F:System.IO.Pipes.PipeAccessRights.ReadData, F:System.IO.Pipes.PipeAccessRights.ReadExtendedAttributes, and F:System.IO.Pipes.PipeAccessRights.ReadPermissions rights.

Write 

Specifies the right to write to the pipe. This right includes the F:System.IO.Pipes.PipeAccessRights.WriteAttributes, F:System.IO.Pipes.PipeAccessRights.WriteData, and F:System.IO.Pipes.PipeAccessRights.WriteExtendedAttributes rights.

ReadWrite 

Specifies the right to read and write from the pipe. This right includes the F:System.IO.Pipes.PipeAccessRights.ReadAttributes, F:System.IO.Pipes.PipeAccessRights.ReadData, F:System.IO.Pipes.PipeAccessRights.ReadExtendedAttributes, F:System.IO.Pipes.PipeAccessRights.ReadPermissions, F:System.IO.Pipes.PipeAccessRights.WriteAttributes, F:System.IO.Pipes.PipeAccessRights.WriteData, and F:System.IO.Pipes.PipeAccessRights.WriteExtendedAttributes rights.

AccessSystemSecurity 

Specifies the right to make changes to the system access control list (SACL).

Definition at line 5 of file PipeAccessRights.cs.

◆ PipeDirection

Specifies the direction of the pipe.

Enumerator
In 

Specifies that the pipe direction is in.

Out 

Specifies that the pipe direction is out.

InOut 

Specifies that the pipe direction is two-way.

Definition at line 5 of file PipeDirection.cs.

◆ PipeOptions

Provides options for creating a T:System.IO.Pipes.PipeStream object. This enumeration has a T:System.FlagsAttribute attribute that allows a bitwise combination of its member values.

Enumerator
None 

Indicates that there are no additional parameters.

WriteThrough 

Indicates that the system should write through any intermediate cache and go directly to the pipe.

Asynchronous 

Indicates that the pipe can be used for asynchronous reading and writing.

Definition at line 6 of file PipeOptions.cs.

◆ PipeTransmissionMode

Specifies the transmission mode of the pipe.

Enumerator
Byte 

Indicates that data in the pipe is transmitted and read as a stream of bytes.

Message 

Indicates that data in the pipe is transmitted and read as a stream of messages.

Definition at line 5 of file PipeTransmissionMode.cs.

Function Documentation

◆ PipeStreamImpersonationWorker()

delegate void System.IO.Pipes.PipeStreamImpersonationWorker ( )

Represents the method to call as the client.