Function rcl_get_default_topic_name_substitutions

Function Documentation

rcl_ret_t rcl_get_default_topic_name_substitutions(rcutils_string_map_t *string_map)

Fill a given string map with the default substitution pairs.

If the string map is not initialized RCL_RET_INVALID_ARGUMENT is returned.

Parameters:

string_map[inout] rcutils_string_map_t map to be filled with pairs

Returns:

RCL_RET_OK if successfully, or

Returns:

RCL_RET_INVALID_ARGUMENT if any arguments are invalid, or

Returns:

RCL_RET_BAD_ALLOC if allocating memory failed, or

Returns:

RCL_RET_ERROR if an unspecified error occurs.