Jump to main content

##

# TCPIP_STACK_HEAP_RES Enumeration

## C

    typedef enum {
    TCPIP_STACK_HEAP_RES_OK = 0,
    TCPIP_STACK_HEAP_RES_INIT_ERR = -1,
    TCPIP_STACK_HEAP_RES_CREATE_ERR = -2,
    TCPIP_STACK_HEAP_RES_SYNCH_ERR = -3,
    TCPIP_STACK_HEAP_RES_BUFF_SIZE_ERR = -4,
    TCPIP_STACK_HEAP_RES_BUFF_ALIGN_ERR = -5,
    TCPIP_STACK_HEAP_RES_NO_MEM = -6,
    TCPIP_STACK_HEAP_RES_IN_USE = -7,
    TCPIP_STACK_HEAP_RES_PTR_ERR = -8,
    TCPIP_STACK_HEAP_RES_NO_HEAP = -9,
    TCPIP_STACK_HEAP_RES_SIZE_ERR = -10
    } TCPIP_STACK_HEAP_RES;

## Description

Enumeration: TCPIP_STACK_HEAP_RES.

Defines the results that could be returned by the TCP/IP stack heap error function.

## Preconditions

None.

## Members

Members | Description
--- | ---
TCPIP_STACK_HEAP_RES_OK = 0 | Everything OK.
TCPIP_STACK_HEAP_RES_INIT_ERR = -1 | Invalid initialization data.
TCPIP_STACK_HEAP_RES_CREATE_ERR = -2 | Could not create a heap.
TCPIP_STACK_HEAP_RES_SYNCH_ERR = -3 | Could not create a synchronization object or synchronization error.
TCPIP_STACK_HEAP_RES_BUFF_SIZE_ERR = -4 | Supplied heap buffer too small.
TCPIP_STACK_HEAP_RES_BUFF_ALIGN_ERR = -5 | Supplied heap buffer not properly aligned.
TCPIP_STACK_HEAP_RES_NO_MEM = -6 | Heap is out of memory.
TCPIP_STACK_HEAP_RES_IN_USE = -7 | Heap in use, cannot be deallocated.
TCPIP_STACK_HEAP_RES_PTR_ERR = -8 | Corrupt pointer.
TCPIP_STACK_HEAP_RES_NO_HEAP = -9 | No such heap exists.
TCPIP_STACK_HEAP_RES_SIZE_ERR = -10 | This size cannot be allocated for a pool heap.

## Remarks

New types could be added in the future. Some results are relevant for specific heap types only.