string_vector.h File Reference

#include <uhd/config.h>
#include <uhd/error.h>
#include <stdlib.h>

Go to the source code of this file.

Typedefs
typedef struct uhd_string_vector_t	uhd_string_vector_t
typedef uhd_string_vector_t *	uhd_string_vector_handle

Functions
UHD_API uhd_error	uhd_string_vector_make (uhd_string_vector_handle *h)
	Instantiate a string_vector handle. More...
UHD_API uhd_error	uhd_string_vector_free (uhd_string_vector_handle *h)
	Safely destroy a string_vector handle. More...
UHD_API uhd_error	uhd_string_vector_push_back (uhd_string_vector_handle *h, const char *value)
	Add a string to the list. More...
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. More...
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. More...
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. More...

Typedef Documentation

uhd_string_vector_handle

typedef uhd_string_vector_t* uhd_string_vector_handle

uhd_string_vector_t

typedef struct uhd_string_vector_t uhd_string_vector_t

Function Documentation

uhd_string_vector_at()

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_string_vector_free()

UHD_API uhd_error uhd_string_vector_free

(

uhd_string_vector_handle *

h

)

Safely destroy a string_vector handle.

uhd_string_vector_last_error()

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_string_vector_make()

UHD_API uhd_error uhd_string_vector_make

(

uhd_string_vector_handle *

h

)

Instantiate a string_vector handle.

uhd_string_vector_push_back()

UHD_API uhd_error uhd_string_vector_push_back	(	uhd_string_vector_handle *	h,
		const char *	value
	)

Add a string to the list.

uhd_string_vector_size()

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.