esp_partition_find() function

Find partition based on one or more parameters

Syntax

Show:

Summary

Declaration

Definition

from esp_partition.h:162

esp_partition_iterator_t esp_partition_find(esp_partition_type_t type, esp_partition_subtype_t subtype, const char* label);

Implemented in partition.c:297

Arguments

Argument

Description

type

Partition type, one of esp_partition_type_t values or an 8-bit unsigned integer. To find all partitions, no matter the type, use ESP_PARTITION_TYPE_ANY, and set subtype argument to ESP_PARTITION_SUBTYPE_ANY.

subtype

Partition subtype, one of esp_partition_subtype_t values or an 8-bit unsigned integer. To find all partitions of given type, use ESP_PARTITION_SUBTYPE_ANY.

label

(optional) Partition label. Set this value if looking for partition with a specific name. Pass NULL otherwise.

Return value

iterator which can be used to enumerate all the partitions found, or NULL if no partitions were found. Iterator obtained through this function has to be released using esp_partition_iterator_release when not used any more.

Examples

esp_partition_find() is referenced by 3 libraries and example projects:

References

from examples

esp_partition_find() function

Syntax

Arguments

Return value

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle