DosCallNPipe - Parameters

pszName (PSZ) - input

The ASCIIZ name of the pipe to be opened.

Pipe names must include the prefix \PIPE\ and must conform to file-system naming conventions. When communicating with a remote process, the computer name must also be included, using the format \\ComputerName\PIPE\FileName.

pInbuf (PVOID) - input

A pointer to the buffer that is to be written to the pipe.

cbIn (ULONG) - input

The number of bytes to be written.

pOutbuf (PVOID) - output

A pointer to the buffer for returned data.

cbOut (ULONG) - input

The maximum size, in bytes, of returned data.

pcbActual (PULONG) - output

A pointer to the ULONG in which the number of bytes actually read is returned.

msec (ULONG) - input

The maximum time, in milliseconds, to wait for a pipe instance to become available.

ulrc (APIRET) - returns

Return Code.

DosCallNPipe returns one of the following values:

• NO_ERROR 2
  ERROR_FILE_NOT_FOUND
  3
  ERROR_PATH_NOT_FOUND
  5
  ERROR_ACCESS_DENIED
  11
  ERROR_BAD_FORMAT
  95
  ERROR_INTERRUPT
  230
  ERROR_BAD_PIPE
  231
  ERROR_PIPE_BUSY
  233
  ERROR_PIPE_NOT_CONNECTED
  234
  ERROR_MORE_DATA
  On the PowerPC platform, DosCallNPipe fails with error code ERROR_PATH_NOT_FOUND when the pipe name contains more than one \ in the name. For example, the following pipe name would cause DosCallNPipe to fail:

    \pipe\\\\\longname.nam

  For a full list of error codes, see Errors.

---

[Back: DosCallNPipe Return Value - ulrc]
[Next: DosCallNPipe - Remarks]