libiio
Functions
Top-level functions

Functions

__api void iio_library_get_version (unsigned int *major, unsigned int *minor, char git_tag[8])
 Get the version of the libiio library. More...
 
__api void iio_strerror (int err, char *dst, size_t len)
 Get a string description of an error code. More...
 
__api __cnst bool iio_has_backend (const char *backend)
 Check if the specified backend is available. More...
 
__api __cnst unsigned int iio_get_backends_count (void)
 Get the number of available backends. More...
 
__api __cnst const char * iio_get_backend (unsigned int index)
 Retrieve the name of a given backend. More...
 

Detailed Description

Function Documentation

§ iio_get_backend()

__api __cnst const char* iio_get_backend ( unsigned int  index)

Retrieve the name of a given backend.

Parameters
indexThe index corresponding to the attribute
Returns
On success, a pointer to a static NULL-terminated string
If the index is invalid, NULL is returned

Introduced in version 0.9.

§ iio_get_backends_count()

__api __cnst unsigned int iio_get_backends_count ( void  )

Get the number of available backends.

Returns
The number of available backends

Introduced in version 0.9.

§ iio_has_backend()

__api __cnst bool iio_has_backend ( const char *  backend)

Check if the specified backend is available.

Parameters
backendThe name of the backend to query
Returns
True if the backend is available, false otherwise

Introduced in version 0.9.

§ iio_library_get_version()

__api void iio_library_get_version ( unsigned int *  major,
unsigned int *  minor,
char  git_tag[8] 
)

Get the version of the libiio library.

Parameters
majorA pointer to an unsigned integer (NULL accepted)
minorA pointer to an unsigned integer (NULL accepted)
git_tagA pointer to a 8-characters buffer (NULL accepted)

§ iio_strerror()

__api void iio_strerror ( int  err,
char *  dst,
size_t  len 
)

Get a string description of an error code.

Parameters
errThe error code
dstA pointer to the memory area where the NULL-terminated string corresponding to the error message will be stored
lenThe available length of the memory area, in bytes