Function rcutils_array_list_fini

• Defined in File array_list.h

Function Documentation

rcutils_ret_t rcutils_array_list_fini(rcutils_array_list_t *array_list)

Finalize an array list, reclaiming all resources.

This function reclaims any memory owned by the array list.

The allocator used to initialize the array list is used to deallocate each entry in the list and the list itself.

Attribute	Adherence
Allocates Memory	No
Thread-Safe	No
Uses Atomics	No
Lock-Free	Yes

Parameters:

array_list – [inout] object to be finalized

Returns:

RCUTILS_RET_OK if successful, or

Returns:

RCUTILS_RET_INVALID_ARGUMENT for invalid arguments, or

Returns:

RCUTILS_RET_ERROR if an unknown error occurs.