esp_partition_find_first() function

Find first partition based on one or more parameters

Syntax

Show:

Summary

Declaration

Definition

from esp_partition.h:178

const esp_partition_t* esp_partition_find_first(esp_partition_type_t type, esp_partition_subtype_t subtype, const char* label);

Implemented in partition.c:353

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

pointer to esp_partition_t structure, or NULL if no partition is found. This pointer is valid for the lifetime of the application.

Examples

esp_partition_find_first() is referenced by 11 libraries and example projects:

References

from examples

esp_partition_find_first() function

Syntax

Arguments

Return value

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle