Stringification

Functions
const char *	libx52_strerror (libx52_error_code error)
	Return a string representation of the error code. More...
const char *	libx52_clock_id_to_str (libx52_clock_id id)
	Returns a string representation of the clock ID. More...
const char *	libx52_clock_format_to_str (libx52_clock_format format)
	Returns a string representation of the clock format. More...
const char *	libx52_date_format_to_str (libx52_date_format format)
	Returns a string representation of the date format. More...
const char *	libx52_led_id_to_str (libx52_led_id id)
	Returns a string representation of the LED. More...
const char *	libx52_led_state_to_str (libx52_led_state state)
	Returns a string representation of the LED state. More...

Detailed Description

Translation APIs from enumerations to string, primarily for logging.

Function Documentation

libx52_clock_format_to_str()

const char* libx52_clock_format_to_str

(

libx52_clock_format

format

)

Returns a string representation of the clock format.

Parameters

[in]

format

Clock format

Returns

Pointer to a NULL terminated string describing the clock format. Returned pointer must not be freed.

libx52_clock_id_to_str()

const char* libx52_clock_id_to_str

(

libx52_clock_id

id

)

Returns a string representation of the clock ID.

Parameters

[in]

id

Clock ID

Returns

Pointer to a NULL terminated string describing the clock ID. Returned pointer must not be freed.

libx52_date_format_to_str()

const char* libx52_date_format_to_str

(

libx52_date_format

format

)

Returns a string representation of the date format.

Parameters

[in]

format

Date format

Returns

Pointer to a NULL terminated string describing the date format. Returned pointer must not be freed.

libx52_led_id_to_str()

const char* libx52_led_id_to_str

(

libx52_led_id

id

)

Returns a string representation of the LED.

Parameters

[in]

id

LED ID

Returns

Pointer to a NULL terminated string describing the LED. Returned pointer must not be freed.

libx52_led_state_to_str()

const char* libx52_led_state_to_str

(

libx52_led_state

state

)

Returns a string representation of the LED state.

Parameters

[in]

state

LED state

Returns

Pointer to a NULL terminated string describing the LED state. Returned pointer must not be freed.

libx52_strerror()

const char* libx52_strerror

(

libx52_error_code

error

)

Return a string representation of the error code.

Parameters

[in]

error

Error code returned by libx52 function

Returns

Pointer to a NULL terminated string describing the error. Returned pointer must not be freed.