PipeStream.ReadMode Property

Reference

Definition

Namespace:: System.IO.Pipes

Assembly:: System.IO.Pipes.dll

Assembly:: System.Core.dll

Assembly:: netstandard.dll

Source:: PipeStream.Unix.cs

Source:: PipeStream.Unix.cs

Source:: PipeStream.Unix.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets or sets the reading mode for a PipeStream object.

public:
 virtual property System::IO::Pipes::PipeTransmissionMode ReadMode { System::IO::Pipes::PipeTransmissionMode get(); void set(System::IO::Pipes::PipeTransmissionMode value); };

public virtual System.IO.Pipes.PipeTransmissionMode ReadMode { get; set; }

public virtual System.IO.Pipes.PipeTransmissionMode ReadMode { [System.Security.SecurityCritical] get; [System.Security.SecurityCritical] set; }

member this.ReadMode : System.IO.Pipes.PipeTransmissionMode with get, set

[<get: System.Security.SecurityCritical>]
[<set: System.Security.SecurityCritical>]
member this.ReadMode : System.IO.Pipes.PipeTransmissionMode with get, set

Public Overridable Property ReadMode As PipeTransmissionMode

Property Value

PipeTransmissionMode

One of the PipeTransmissionMode values that indicates how the PipeStream object reads from the pipe.

Attributes: SecurityCriticalAttribute

Exceptions

ArgumentOutOfRangeException

The supplied value is not a valid PipeTransmissionMode value.

NotSupportedException

The supplied value is not a supported PipeTransmissionMode value for this pipe stream.

InvalidOperationException

The handle has not been set.

-or-

The pipe is waiting to connect with a named client.

IOException

The pipe is broken or an I/O error occurred with a named client.

Remarks

Anonymous pipes do not support Message mode message transmission.

To avoid an InvalidOperationException accessing ReadMode, IsConnected can be used to verify the pipe is connected.

Applies to