Function rmw_validate_node_name_with_size

Function Documentation

rmw_ret_t rmw_validate_node_name_with_size(const char *node_name, size_t node_name_length, int *validation_result, size_t *invalid_index)

Deterimine if a given node name is valid.

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

See also

rmw_validate_node_name(const char *, int *, size_t *)

Parameters:

  • node_name – [in] node name to be validated

  • node_name_length – [in] The number of characters in node_name.

  • validation_result – [out] int in which the result of the check is stored

  • invalid_index – [out] size_t index of the input string where an error occurred

Returns:

RMW_RET_OK on successfully running the check, or

Returns:

RMW_RET_INVALID_ARGUMENT on invalid parameters, or

Returns:

RMW_RET_ERROR when an unspecified error occurs.