Jump to main content

##

# TCPIP_TCP_ArrayPeek Function

## C

    uint16_t TCPIP_TCP_ArrayPeek(
        TCP_SOCKET hTCP,
        uint8_t * vBuffer,
        uint16_t wLen,
        uint16_t wStart
    );

## Description

This function reads a specified number of data bytes from the TCP RX FIFO without removing them from the buffer. No TCP control actions are taken as a result of this function (ex: no window update is sent to the remote node).

## Preconditions

TCP is initialized.

## Parameters

Parameters | Description
--- | ---
hTCP | The socket to peek from (read without removing from stream).
vBuffer | Destination to write the peeked data bytes.
wLen | Length of bytes to peek from the RX FIFO and copy to vBuffer.
wStart | Zero-indexed starting position within the FIFO from which to start peeking.

## Remarks

None.