Function rcl_arguments_get_param_overrides

• Defined in File arguments.h

Function Documentation

rcl_ret_t rcl_arguments_get_param_overrides(const rcl_arguments_t *arguments, rcl_params_t **parameter_overrides)

Return all parameter overrides parsed from the command line.

Parameter overrides are parsed directly from command line arguments and parameter files provided in the command line.

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

Parameters:

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

• parameter_overrides – [out] Parameter overrides as parsed from command line arguments. This structure must be finalized by the caller. The output is NULL if no parameter overrides were parsed.

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.