Function rcl_validate_topic_name_with_size

Function Documentation

rcl_ret_t rcl_validate_topic_name_with_size(const char *topic_name, size_t topic_name_length, int *validation_result, size_t *invalid_index)

Validate a given topic name.

This is an overload with an extra parameter for the length of topic_name.

See also

rcl_validate_topic_name()

Parameters:

  • topic_name – [in] the topic name to be validated, must be null terminated

  • topic_name_length – [in] The number of characters in topic_name.

  • validation_result – [out] the reason for validation failure, if any

  • invalid_index – [out] index of violation if the input topic is invalid

Returns:

RCL_RET_OK if the topic name was expanded successfully, or

Returns:

RCL_RET_INVALID_ARGUMENT if any arguments are invalid, or

Returns:

RCL_RET_ERROR if an unspecified error occurs.