SysWaitNamedPipe

Function:

SysWaitNamedPipe
Syntax:
result = SysWaitNamedPipe(name, [timeout])

name

The name of the named pipe. Named pipe names must be of the form "\PIPE\pipename".
timeout
The number of microseconds to wait on the pipe. If timeout is omitted or is zero, the default timeout value is be used. A value of -1 can be used to wait until the pipe is no longer busy.
result
The return code from DosWaitNmPipe. The following return codes are of particular interest:
• The named pipe is no longer busy.

• The named pipe was not found.

  231

  The wait timed out before the pipe became available.
  Purpose:
  Perform a timed wait on a named pipe.

  Examples:
    /* Code    */
     Parse value stream(PipeName,'C','OPEN') with PipeState ':' OS2RC
     If OS2RC=231 then call SysWaitNamedPipe(PipeName, -1)
  

  ---

  [Back: SysTextScreenSize]
  [Next: Arithmetic Examples]