Function rosidl_runtime_c__String__Sequence__init

Function Documentation

bool rosidl_runtime_c__String__Sequence__init(rosidl_runtime_c__String__Sequence *sequence, size_t size)

Initialize a rosidl_runtime_c__String__Sequence__init structure.

The rosidl_runtime_c__String__Sequence is initialized with the size passed to the function. The rosidl_runtime_c__String__Sequence structure should be deallocated using the given function rosidl_runtime_c__String__Sequence__fini() when it is no longer needed. Calling this function with an already initialized U16 string sequence structure will leak memory.

Parameters:

  • sequence – [inout] a pointer to a string sequence

  • size – [in] represents the size of the string sequence

Returns:

true if successful, false if the passed string pointer is null or the memory allocation failed