Function rcl_arguments_get_unparsed_ros

• Defined in File arguments.h

Function Documentation

rcl_ret_t rcl_arguments_get_unparsed_ros(const rcl_arguments_t *args, rcl_allocator_t allocator, int **output_unparsed_ros_indices)

Return a list of indices to unknown ROS specific arguments that were left unparsed.

Some ROS specific arguments may not have been recognized, or were not intended to be parsed by rcl. This function populates an array of indices to these arguments in the original argv array.

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

Parameters:

• args – [in] An arguments structure that has been parsed.

• allocator – [in] A valid allocator.

• output_unparsed_ros_indices – [out] An allocated array of indices into the original argv array. This array must be deallocated by the caller using the given allocator. If there are no unparsed ROS specific arguments then the output will be set to NULL.

Returns:

RCL_RET_OK if everything goes correctly, or

Returns:

RCL_RET_INVALID_ARGUMENT if any function arguments are invalid, or

Returns:

RCL_RET_BAD_ALLOC if allocating memory failed, or

Returns:

RCL_RET_ERROR if an unspecified error occurs.