Function rcutils_uint8_array_fini

Function Documentation

rcutils_ret_t rcutils_uint8_array_fini(rcutils_uint8_array_t *uint8_array)

Finalize a uint8 array struct.

Cleans up and deallocates any resources used in a rcutils_uint8_array_t. The array passed to this function needs to have been initialized by rcutils_uint8_array_init(). Passing an uninitialized instance to this function leads to undefined behavior.

Parameters:

uint8_array[in] pointer to the rcutils_uint8_array_t to be cleaned up

Returns:

RCUTILS_RET_OK if successful, or

Returns:

RCUTILS_RET_INVALID_ARGUMENT if the uint8_array argument is invalid

Returns:

RCUTILS_RET_ERROR if an unexpected error occurs.