PipeStream

(Engine-Level Function)

Description: Returns a stream based on an operating system named pipe.
Returns: Stream
Usage: Script Only.
Function Groups: Stream and Socket
Related to: BlockWrite| BuffStream | CloseStream | FileStream | GetStreamLength | PeekStream | SRead | StreamEnd | SWrite
Format: PipeStream(Name, Mode)
Parameters:  
Name
Required. Any text expression giving the name of the named pipe.
Mode
Required. Any numeric expression giving the manner in which the pipe is opened, as shown in the following table:

Mode

Open state

0

Not opened yet

1

Opened for read

2

Opened for read or write

Comments: None

Example:

If ! Valid(pStream);
[
  pStream = PipeStream("\\dataserv\datapipe", 1);
]

This opens a pipe named pStream as a stream from which to read data.