osPoolFree() function

Return an allocated memory block back to a specific memory pool

Syntax

Show:

Summary

Declaration

Definition

from cmsis_os.h:745

osStatus osPoolFree (osPoolId pool_id, void *block);

Implemented in cmsis_os.c:996

Arguments

Argument

Description

pool_id

memory pool ID obtain referenced with osPoolCreate.

block

address of the allocated memory block that is returned to the memory pool.

Return value

status code that indicates the execution status of the function.

Notes

MUST REMAIN UNCHANGED: \b osPoolFree shall be consistent in every CMSIS-RTOS.

Examples

References

from examples

osPoolFree() function

Syntax

Arguments

Return value

Notes

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle

osPoolFree() function

Syntax

Arguments

Return value

Notes

Related Functions

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle