Channel list

Detailed Description

Typedefs
typedef struct ed247_internal_channel_list_t *	ed247_channel_list_t
	Channel list identifier.

Functions
LIBED247_EXPORT ed247_status_t	ed247_channel_list_size (ed247_channel_list_t channels, uint32_t *size)
	Get the size of the list. More...
LIBED247_EXPORT ed247_status_t	ed247_channel_list_next (ed247_channel_list_t channels, ed247_channel_t *channel)
	Iterate over a channel identifier list. More...
LIBED247_EXPORT ed247_status_t	ed247_channel_list_free (ed247_channel_list_t channels)
	Free channel list. More...

Function Documentation

LIBED247_EXPORT ed247_status_t ed247_channel_list_size	(	ed247_channel_list_t	channels,
		uint32_t *	size
	)

Get the size of the list.

Parameters

[in]	channels	The channel list
[out]	size	The size of the list

Return values

ED247_STATUS_SUCCESS
ED247_STATUS_FAILURE

LIBED247_EXPORT ed247_status_t ed247_channel_list_next	(	ed247_channel_list_t	channels,
		ed247_channel_t *	channel
	)

Iterate over a channel identifier list.

A null value is set when the end of the list is reached. Return value is ED247_STATUS_SUCCESS. The next call will return the pointer to the first item of the list.

Parameters

[in,out]	channels	The channel list
[out]	channel	A pointer to the current item in the list.

Return values

ED247_STATUS_SUCCESS	Operation completed successfully even if end of list may be reached
ED247_STATUS_FAILURE	Invalid parameter provided or internal error

LIBED247_EXPORT ed247_status_t ed247_channel_list_free

(

ed247_channel_list_t

channels

)

Free channel list.

Parameters

[in]

channels

The channel list

Return values

ED247_STATUS_SUCCESS
ED247_STATUS_FAILURE