Function rcl_arguments_get_param_files

• Defined in File arguments.h

Function Documentation

rcl_ret_t rcl_arguments_get_param_files(const rcl_arguments_t *arguments, rcl_allocator_t allocator, char ***parameter_files)

Return a list of yaml parameter file paths specified on 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.

• allocator – [in] A valid allocator.

• parameter_files – [out] An allocated array of paramter file names. This array must be deallocated by the caller using the given allocator. The output is NULL if there were no paramter files.

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.