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 DosQNmPipeInfo(hp, usInfoLevel, pbBuf, cbBuf)
HPIPE hp;              /* pipe handle                       */
USHORT usInfoLevel;    /* level of information to retrieve  */
PBYTE  pbBuf;          /* pointer to buffer for information */
USHORT cbBuf;          /* number of bytes in buffer         */
 
The DosQNmPipeInfo function retrieves information about a named pipe.
 
Parameter    Description
────────────────────────────────────────────────────────────────────────────
 
hp           Identifies the pipe to read from.
 
usInfoLevel  Specifies the level of information to retrieve. Level 1 is
             miscellaneous information about the pipe.
 
pbBuf        Points to the buffer that receives the information. For level-1
             information, the data is stored in the PIPEINFO structure.
 
cbBuf        Specifies the size (in bytes) of the buffer receiving the
             information.
 
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_BUFFER_OVERFLOW
     ERROR_INVALID_LEVEL
     ERROR_INVALID_PARAMETER
     ERROR_PIPE_NOT_CONNECTED
 
Comments
 
For level-1 information, if the pipe name is longer than 255 bytes, zero
will be returned in the cbName field of the PIPEINFO structure. The full
null-terminated string that contains the name will be returned in the
location specified by the szName field.
 
See Also
 
DosQNmPHandState, DosQNmPipeSemState, PIPEINFO
 
                                      ♦