Function rcl_arguments_get_unparsed

Function Documentation

rcl_ret_t rcl_arguments_get_unparsed(const rcl_arguments_t *args, rcl_allocator_t allocator, int **output_unparsed_indices)

Return a list of indices to non ROS specific arguments.

Non ROS specific arguments may have been provided i.e. arguments outside a ‘—ros-args’ scope. This function populates an array of indices to these arguments in the original argv array. Since the first argument is always assumed to be a process name, the list will always contain the index 0.

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_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 args 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.