USRP Hardware Driver and USRP Manual  Version: 3.13.0.HEAD-0-gf114cfa0
UHD and USRP Manual
string_vector.h
Go to the documentation of this file.
1 /*
2  * Copyright 2015 Ettus Research
3  * Copyright 2018 Ettus Research, a National Instruments Company
4  *
5  * SPDX-License-Identifier: GPL-3.0-or-later
6  */
7 
8 #ifndef INCLUDED_UHD_TYPES_STRING_VECTOR_H
9 #define INCLUDED_UHD_TYPES_STRING_VECTOR_H
10 
11 #include <uhd/config.h>
12 #include <uhd/error.h>
13 
14 #include <stdlib.h>
15 
16 #ifdef __cplusplus
17 #include <string>
18 #include <vector>
19 
20 struct uhd_string_vector_t {
21  std::vector<std::string> string_vector_cpp;
22  std::string last_error;
23 };
24 
25 extern "C" {
26 #else
27 struct uhd_string_vector_t;
29 #endif
30 
32 
34 
37  uhd_string_vector_handle *h
38 );
39 
42  uhd_string_vector_handle *h
43 );
44 
47  uhd_string_vector_handle *h,
48  const char* value
49 );
50 
53  uhd_string_vector_handle h,
54  size_t index,
55  char* value_out,
56  size_t strbuffer_len
57 );
58 
61  uhd_string_vector_handle h,
62  size_t *size_out
63 );
64 
67  uhd_string_vector_handle h,
68  char* error_out,
69  size_t strbuffer_len
70 );
71 
72 #ifdef __cplusplus
73 }
74 #endif
75 
76 #endif /* INCLUDED_UHD_TYPES_STRING_VECTOR_H */
UHD_API uhd_error uhd_string_vector_push_back(uhd_string_vector_handle *h, const char *value)
Add a string to the list.
struct uhd_string_vector_t uhd_string_vector_t
Definition: string_vector.h:31
UHD_API uhd_error uhd_string_vector_size(uhd_string_vector_handle h, size_t *size_out)
Get the number of strings in this list.
uhd_error
UHD error codes.
Definition: error.h:21
UHD_API uhd_error uhd_string_vector_at(uhd_string_vector_handle h, size_t index, char *value_out, size_t strbuffer_len)
Get the string at the given index.
UHD_API uhd_error uhd_string_vector_last_error(uhd_string_vector_handle h, char *error_out, size_t strbuffer_len)
Get the last error reported by the underlying object.
UHD_API uhd_error uhd_string_vector_make(uhd_string_vector_handle *h)
Instantiate a string_vector handle.
uhd_string_vector_t * uhd_string_vector_handle
Definition: string_vector.h:33
#define UHD_API
Definition: config.h:63
UHD_API uhd_error uhd_string_vector_free(uhd_string_vector_handle *h)
Safely destroy a string_vector handle.