DosWaitNmPipe

This call waits for the availability of a named pipe instance.

Syntax
DosWaitNmPipe (FileName, TimeOut)

Parameters

 * FileName (PSZ) - input : Address of the ASCIIZ name of the pipe to be opened. Pipes are name \PIPE\FileName.
 * TimeOut (ULONG) - input : Maximum time in milliseconds to wait for the named pipe to become available. When a zero value is used, the DosMakeNmPipe specified default value is used. When a minus one value is used, an indefinite wait is entered.

Return Code

 * rc (USHORT) - return:Return code descriptions are:
 * 0 NO_ERROR
 * 2 ERROR_FILE_NOT_FOUND
 * 95 ERROR_INTERRUPT
 * 231 ERROR_PIPE_BUSY

Remarks
This call should be used only when ERROR_PIPE_BUSY is returned from a DosOpen call.

DosWaitNmPipe allows an application to wait for a server on a named pipe for which all instances are currently busy. The call waits up to TimeOut milliseconds (or a default time if TimeOut is zero).

When a pipe instance becomes available, it is given to the process whose thread has the highest priority. The priority of a thread may be changed with DosSetPrty.

C

 * 1) define INCL_DOSNMPIPES

USHORT rc = DosWaitNmPipe(FileName, TimeOut);

PSZ    FileName;      /* Pipe name */ ULONG  TimeOut;       /* Maximum wait time */

USHORT rc;            /* return code */ 

MASM
 EXTRN DosWaitNmPipe:FAR INCL_DOSNMPIPES    EQU 1

PUSH@ ASCIIZ  FileName      ;Pipe name PUSH  DWORD   TimeOut       ;Maximum wait time CALL  DosWaitNmPipe

Returns WORD 