DosQNmPipeInfo

This call returns information for a named pipe.

DosQNmPipeInfo

(Handle, InfoLevel, InfoBuf, InfoBufSize)

Handle (HPIPE) - input

Handle of the named pipe that is returned by DosMakeNmPipe or DosOpen.
InfoLevel (USHORT) - input
Level of the required pipe information. Only level 1 file information is supported.
InfoBuf (PBYTE) - output
Address of the storage area that returns the requested level of named pipe information. For InfoLevel = 1, file information is returned in the following format:

outbufsize (USHORT)

Actual size of buffer for outgoing I/O.
inbufsize (USHORT)
Actual size of buffer for ingoing I/O.
maxnuminstances (UCHAR)
Maximum allowed number of pipe instances.
numinstances (UCHAR)
Current number of pipe instances.
namelength (UCHAR)
Length of pipe name.
pipename (CHAR)
Name of pipe (including \\ComputerName, if remote).
InfoBufSize (USHORT) - input
Length of InfoBuf.
rc (USHORT) - return
Return code descriptions are:
• NO_ERROR 111
  ERROR_BUFFER_OVERFLOW
  124
  ERROR_INVALID_LEVEL
  230
  ERROR_BAD_PIPE
  Remarks

  DosQNmPipeInfo returns all the information that fits in InfoBuf.

  For level 1 information, if the length of the name of the pipe is greater than 255 bytes, then a length of zero is returned in the length field. The full ASCIIZ name will still be returned in this case.

  ---

  [Back: DosQNmPHandState]
  [Next: DosQNmPipeSemState]