Function rcutils_array_list_remove

• Defined in File array_list.h

Function Documentation

rcutils_ret_t rcutils_array_list_remove(rcutils_array_list_t *array_list, size_t index)

Removes an entry in the list at the provided index.

This function removes data from the list at the specified index. The capacity of the list will never decrease when entries are removed.

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

Parameters:

• array_list – [in] to add the data to

• index – [in] the index of the item to remove from the list

Returns:

RCUTILS_RET_OK if successful, or

Returns:

RCUTILS_RET_INVALID_ARGUMENT for invalid arguments, or

Returns:

RCUTILS_RET_INVALID_ARGUMENT if index out of bounds, or

Returns:

RCUTILS_RET_ERROR if an unknown error occurs.