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►                                      ◄Up► ◄Next► ◄Previous►
────────────────────────────────────────────────────────────────────────────
 
#define INCL_DOSNMPIPES
 
USHORT DosSetNmPHandState(hp, fsState)
HPIPE hp;          /* pipe handle */
USHORT fsState;    /* state flag  */
 
The DosSetNmPHandState function is used to set the read mode and the
blocking mode of a named pipe.
 
Parameter  Description
────────────────────────────────────────────────────────────────────────────
 
hp         Identifies the pipe to read from.
 
fsState    Specifies the new mode. The mode is a combination of a read-mode
           flag and a wait flag. The possible values are:
 
           Value                  Meaning
           ─────────────────────────────────────────────────────────────────
           PIPE_READMODE_BYTE     Read pipe as a byte stream.
 
           PIPE_READMODE_MESSAGE  Read pipe as a message stream.
 
           PIPE_NOWAIT            Reading from and writing to the pipe
                                  returns immediately if no data is
                                  available.
 
           PIPE_WAIT              Reading from and writing to the pipe waits
                                  if no data is available.
 
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_INVALID_PARAMETER
     ERROR_PIPE_NOT_CONNECTED
 
See Also
 
DosQNmPHandState
 
                                      ♦