niklas/rcl
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

update doc for rmw_get_node_names to mention potential null values (#214)

Browse source
This commit is contained in:
Dirk Thomas 2018-03-30 10:56:42 -07:00 • committed by GitHub
parent 952c24f8a6
commit d41c923927
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 1 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

1
rcl/include/rcl/graph.h
View file

@ -166,6 +166,7 @@ rcl_names_and_types_fini(rcl_names_and_types_t * names_and_types);
* The node_names parameter must be allocated and zero initialized. * The node_names parameter must be allocated and zero initialized.
* The node_names is the output for this function, and contains * The node_names is the output for this function, and contains
* allocated memory. * allocated memory.
* Note that entries in the array might contain `NULL` value.
* Use rcutils_get_zero_initialized_string_array() for initializing an empty * Use rcutils_get_zero_initialized_string_array() for initializing an empty
* rcutils_string_array_t struct. * rcutils_string_array_t struct.
* This node_names struct should therefore be passed to rcutils_string_array_fini() * This node_names struct should therefore be passed to rcutils_string_array_fini()