Jump to main content

##

# TCPIP_STACK_HEAP_LastError Function

## C

    TCPIP_STACK_HEAP_RES TCPIP_STACK_HEAP_LastError(
        TCPIP_STACK_HEAP_HANDLE heapH
    );

## Description

This function returns the last error encountered in a heap operation. It clears the value of the last error variable.

## Preconditions

heapH - valid heap handle.

## Parameters

Parameters | Description
--- | ---
heapH | Handle to a heap.

## Returns

- The last error encountered in an operation
- TCPIP_STACK_HEAP_RES_OK if no error occurred.

## Remarks

The heap holds an error variable storing the last error encountered in an operation. This should be consulted by the caller after each operation that returns an invalid result for checking what the error condition was.