Important Notice

The pages on this site contain documentation for very old MS-DOS software, purely for historical purposes. If you're looking for up-to-date documentation, particularly for programming, you should not rely on the information found here, as it will be woefully out of date.

◄Function Group►  ◄Changes►                           ◄Up► ◄Next► ◄Previous►
────────────────────────────────────────────────────────────────────────────
 
#define INCL_DOSNMPIPES
 
USHORT DosWaitNmPipe(pszName, ulTimeOut)
PSZ pszName;        /* pointer to pipe name */
ULONG ulTimeOut;    /* time-out value       */
 
The DosWaitNmPipe function waits for a named pipe to become available.
 
Parameter  Description
────────────────────────────────────────────────────────────────────────────
 
pszName    Points to the pipe name. The name is in the form \pipe\name for a
           local pipe and \\server\pipe\name for a remote pipe.
 
ulTimeOut  Specifies the amount of time (in milliseconds) MS OS/2 should
           wait for the pipe to become available. A value of
           NP_INDEFINITE_WAIT causes an infinite wait. A value of
           NP_DEFAULT_WAIT causes the system to wait for the default time
           specified by the call to the DosMakeNmPipe function that created
           this named pipe.
 
Return Value
 
The return value is zero if the function is successful. Otherwise, it is an
error value, which may be one of the following:
 
     ERROR_BAD_PIPE
     ERROR_INTERRUPT
     ERROR_SEM_TIMEOUT
 
Comments
 
The DosWaitNmPipe function should be used only when the DosOpen function
returns the ERROR_PIPE_BUSY error value.
 
If more than one process has requested a named pipe that has become
available, MS OS/2 gives the pipe to the process that has been waiting the
longest.
 
See Also
 
DosOpen
 
                                      ♦