heap_caps_get_free_size() function

Get the total free size of all the regions that have the given capabilities This function takes all regions capable of having the given capabilities allocated in them and adds up the free space they have.

Syntax

Show:

Summary

Declaration

Definition

from esp_heap_caps.h:216

size_t heap_caps_get_free_size( uint32_t caps );

Implemented in heap_caps.c:277

Arguments

Argument

Description

caps

Bitwise OR of MALLOC_CAP_* flags indicating the type of memory

Return value

Amount of free bytes in the regions

Notes

Note that because of heap fragmentation it is probably not possible to allocate a single block of memory of this size. Use heap_caps_get_largest_free_block() for this purpose.

Examples

heap_caps_get_free_size() is referenced by 4 libraries and example projects:

References

from examples

heap_caps_get_free_size() function

Syntax

Arguments

Return value

Notes

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle