SysPipeWindowsRead (FUN)

FUNCTION SysPipeWindowsRead : RTS_IEC_RESULT

This function can be used to read a defined number of bytes from a named pipe.

InOut:

Scope

Name

Type

Comment

Return

SysPipeWindowsRead

RTS_IEC_RESULT
Error code:

  • ERR_OK: Success

  • ERR_PARAMETER: Any of the following

    • hPipe = NULL

    • hPipe = RTS_INVALID_HANDLE

    • pbyBuffer = NULL

    • (dwTimeoutMs <> 0) AND (pipe was not opened with parameter xOverlapped = TRUE)

  • ERR_END_OF_OBJECT: Reading the pipe resulted in ERROR_BROKEN_PIPE

  • ERR_TIMEOUT: dwTimeoutMs has been nonzero and the specified timeout interval has elapsed.

  • ERR_NET_NOTCONNECTED: ERROR_PIPE_NOT_CONNECTED.

  • ERR_NOTHING_TO_DO: ERROR_NO_DATA.

  • ERR_FAILED: Any other error (see log)

Input

hPipe

RTS_IEC_HANDLE

Handle to a SysPipeWindows instance

pbyBuffer

POINTER TO BYTE

Buffer

uxSize

__UXINT

Number of bytes to read

puxBytesRead

POINTER TO __UXINT

Number of bytes read from the named pipe

dwTimeoutMs

DWORD

Timeout in milliseconds for overlapped reading. Set to 0 for synchronous not overlapped reading. Has to be 0 if the pipe was not opened with parameter xOverlapped = TRUE.