Jump to main content

##

# TCPIP_STACK_HEAP_MaxSize Function

## C

    size_t TCPIP_STACK_HEAP_MaxSize(
        TCPIP_STACK_HEAP_HANDLE heapH
    );

## Description

This function returns the maximum size of a block that can be currently allocated from this heap.

## Preconditions

heapH - valid heap handle.

## Parameters

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

## Returns

- The maximum size of a block that can be allocated from the heap.

## Remarks

This is info only. It can change if the heap has multiple clients. The call could be expensive. The entire heap has to be traversed to find the maximum. If the heap is really fragmented this might take some time.