NamedPipeServerStream Constructor (String, PipeDirection, Int32, PipeTransmissionMode, PipeOptions, Int32, Int32)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Initializes a new instance of the NamedPipeServerStream class with the specified pipe name, pipe direction, maximum number of server instances, transmission mode, pipe options, and recommended in and out buffer sizes.

Namespace:   System.IO.Pipes
Assembly:  System.Core (in System.Core.dll)

public NamedPipeServerStream(
	string pipeName,
	PipeDirection direction,
	int maxNumberOfServerInstances,
	PipeTransmissionMode transmissionMode,
	PipeOptions options,
	int inBufferSize,
	int outBufferSize
)

Parameters

pipeName
Type: System.String

The name of the pipe.

direction
Type: System.IO.Pipes.PipeDirection

One of the enumeration values that determines the direction of the pipe.

maxNumberOfServerInstances
Type: System.Int32

The maximum number of server instances that share the same name. You can pass MaxAllowedServerInstances for this value.

transmissionMode
Type: System.IO.Pipes.PipeTransmissionMode

One of the enumeration values that determines the transmission mode of the pipe.

options
Type: System.IO.Pipes.PipeOptions

One of the enumeration values that determines how to open or create the pipe.

inBufferSize
Type: System.Int32

A positive value greater than 0 that indicates the input buffer size.

outBufferSize
Type: System.Int32

A positive value greater than 0 that indicates the output buffer size.

Exception Condition
ArgumentNullException

pipeName is null.

ArgumentException

pipeName is a zero-length string.

ArgumentOutOfRangeException

pipeName is set to "anonymous".

-or-

direction is not a valid PipeDirection value.

-or-

maxNumberofServerInstances is less than -1 or greater than 254 (-1 indicates MaxAllowedServerInstances)

-or-

options is not a valid PipeOptions value.

-or-

inBufferSize is negative.

NotSupportedException

pipeName contains a colon (":").

PlatformNotSupportedException

The operating system is Windows Millennium Edition, Windows 98, or Windows 95, which are not supported.

IOException

The maximum number of server instances has been exceeded.

This constructor creates a NamedPipeServerStream object that has the following characteristics:

Demand

For full trust for the immediate caller. This member cannot be used by partially trusted code.

.NET Framework
Available since 3.5
Return to top
Show: