Signal list

Detailed Description

Typedefs
typedef struct ed247_internal_signal_list_t *	ed247_signal_list_t
	Signal list identifier.

Functions
LIBED247_EXPORT ed247_status_t	ed247_signal_list_size (ed247_signal_list_t signals, uint32_t *size)
	Get the size of the list. More...
LIBED247_EXPORT ed247_status_t	ed247_signal_list_next (ed247_signal_list_t signals, ed247_signal_t *signal)
	Iterate over a signal identifier list. More...
LIBED247_EXPORT ed247_status_t	ed247_signal_list_free (ed247_signal_list_t signals)
	Free signal list. More...

Function Documentation

LIBED247_EXPORT ed247_status_t ed247_signal_list_size	(	ed247_signal_list_t	signals,
		uint32_t *	size
	)

Get the size of the list.

Parameters

[in]	signals	The signal list
[out]	size	The size of the list

Return values

ED247_STATUS_SUCCESS
ED247_STATUS_FAILURE

LIBED247_EXPORT ed247_status_t ed247_signal_list_next	(	ed247_signal_list_t	signals,
		ed247_signal_t *	signal
	)

Iterate over a signal 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]	signals	The signal list
[out]	signal	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_signal_list_free

(

ed247_signal_list_t

signals

)

Free signal list.

Parameters

[in]

signals

The signal list

Return values

ED247_STATUS_SUCCESS
ED247_STATUS_FAILURE