rcutils  master
C API providing common utilities and data structures.
string_array.h
Go to the documentation of this file.
1 // Copyright 2017 Open Source Robotics Foundation, Inc.
2 //
3 // Licensed under the Apache License, Version 2.0 (the "License");
4 // you may not use this file except in compliance with the License.
5 // You may obtain a copy of the License at
6 //
7 // http://www.apache.org/licenses/LICENSE-2.0
8 //
9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS IS" BASIS,
11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 // See the License for the specific language governing permissions and
13 // limitations under the License.
14 
15 #ifndef RCUTILS__TYPES__STRING_ARRAY_H_
16 #define RCUTILS__TYPES__STRING_ARRAY_H_
17 
18 #if __cplusplus
19 extern "C"
20 {
21 #endif
22 
23 #include <string.h>
24 
25 #include "rcutils/allocator.h"
26 #include "rcutils/macros.h"
29 
31 {
32  size_t size;
33  char ** data;
36 
38 
58 
60 
91  rcutils_string_array_t * string_array,
92  size_t size,
93  rcutils_allocator_t * allocator);
94 
96 
112 
113 #if __cplusplus
114 }
115 #endif
116 
117 #endif // RCUTILS__TYPES__STRING_ARRAY_H_
int rcutils_ret_t
Definition: rcutils_ret.h:23
rcutils_ret_t rcutils_string_array_init(rcutils_string_array_t *string_array, size_t size, rcutils_allocator_t *allocator)
Initialize a string array with a given size.
#define RCUTILS_PUBLIC_TYPE
Definition: visibility_control.h:51
struct rcutils_string_array_t rcutils_string_array_t
Encapsulation of an allocator.
Definition: allocator.h:43
rcutils_ret_t rcutils_string_array_fini(rcutils_string_array_t *string_array)
Finalize a string array, reclaiming all resources.
#define RCUTILS_WARN_UNUSED
Definition: macros.h:24
rcutils_string_array_t rcutils_get_zero_initialized_string_array(void)
Return an empty string array struct.
#define RCUTILS_PUBLIC
Definition: visibility_control.h:48
char ** data
Definition: string_array.h:33
size_t size
Definition: string_array.h:32
rcutils_allocator_t allocator
Definition: string_array.h:34
Definition: string_array.h:30