Function rcutils_array_list_get_size

Function Documentation

rcutils_ret_t rcutils_array_list_get_size(const rcutils_array_list_t *array_list, size_t *size)

Retrieves the size of the provided array_list.

This function retrieves the number of items in the provided array list

Attribute

Adherence

Allocates Memory

No

Thread-Safe

No

Uses Atomics

No

Lock-Free

Yes

Parameters:
  • array_list[in] list to get the size of

  • size[out] The number of items currently stored in the list

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.