RttcpipFrameAllocate

RttcpipFrameAllocate can be used by a filter driver, and an eRTOS application with TCP/IP support enabled, to allocate a block of memory to store an Ethernet frame. The length of the frame is guaranteed to be long enough to contain ulDataSize bytes of data plus 14 bytes for the Ethernet header. RttcpipFrameAllocate pre-populates the source Ethernet address of the device name passed.

Note: Frames must be released by calling RttcpipFrameFree API.

Syntax

Copy

VOID* RttcpipFrameAllocate(
   CHAR *DevName,
   ULONG ulDataSize
);

Parameters

Devname

Zero terminated string indicating which device to allocate a frame from.

ulDataSize

Size of the Ethernet payload data. This size does not include the 14 byte Ethernet header.

Return Value

If this function succeeds, it returns a pointer to the Ethernet frame header of newly created frame. If this function fails, it returns NULL.

Requirements

Minimum supported version	Header	Library
eRTOS 1.0 SDK	RttcpipApi.h	RtTcpipApi.lib