SysPipeWindowsPeek (FUN)¶

FUNCTION SysPipeWindowsPeek : RTS_IEC_RESULT

Read without removing the contents of a pipe. Copies data from a named or anonymous pipe into a buffer without removing it from the pipe. It also returns information about data in the pipe.

InOut:

Scope	Name	Type	Comment
Return	SysPipeWindowsPeek	RTS_IEC_RESULT	Error code: ERR_OK: Success ERR_NET_NOTCONNECTED: ERROR_PIPE_NOT_CONNECTED ERR_END_OF_OBJECT: ERROR_BROKEN_PIPE
Input	hPipe	RTS_IEC_HANDLE	Handle to a SysPipeWindows instance
	pbyBuffer	POINTER TO BYTE	A pointer to a buffer that receives data read from the pipe. This parameter can be NULL if no data is to be read.
	uxSize	__UXINT	The size of the buffer specified by the lpBuffer parameter, in bytes. This parameter is ignored if lpBuffer is NULL.
	puxBytesRead	POINTER TO __UXINT	A pointer to a variable that receives the number of bytes read from the pipe. This parameter can be NULL if no data is to be read
	puxTotalBytesAvail	POINTER TO __UXINT	A pointer to a variable that receives the total number of bytes available to be read from the pipe. This parameter can be NULL if no data is to be read.
	puxBytesLeftThisMessage	POINTER TO __UXINT	A pointer to a variable that receives the number OF bytes remaining in this message. This parameter will be zero for byte-type named pipes or for anonymous pipes. This parameter can be NULL if no data is to be read.