libvlc_exception
[libvlc, libvlc_core]

Collaboration diagram for libvlc_exception:

LibVLC Exceptions handling. More...

Data Structures
struct	libvlc_exception_t
Functions
void	libvlc_exception_init (libvlc_exception_t *p_exception)
	Initialize an exception structure.
int	libvlc_exception_raised (const libvlc_exception_t *p_exception)
	Has an exception been raised?
void	libvlc_exception_raise (libvlc_exception_t *p_exception, const char *psz_format,...)
	Raise an exception using a user-provided message.
void	libvlc_exception_clear (libvlc_exception_t *)
	Clear an exception object so it can be reused.
const char *	libvlc_exception_get_message (const libvlc_exception_t *p_exception)
	Get an exception's message.

---

Detailed Description

LibVLC Exceptions handling.

---

Function Documentation

void libvlc_exception_clear

(

libvlc_exception_t *

)

Clear an exception object so it can be reused.

The exception object must have be initialized.

Parameters:

p_exception

the exception to clear

const char* libvlc_exception_get_message

(

const libvlc_exception_t *

p_exception

)

Get an exception's message.

Parameters:

p_exception

the exception to query

Returns:

the exception message or NULL if not applicable (exception not raised, for example)

void libvlc_exception_init

(

libvlc_exception_t *

p_exception

)

Initialize an exception structure.

This can be called several times to reuse an exception structure.

Parameters:

p_exception

the exception to initialize

void libvlc_exception_raise	(	libvlc_exception_t *	p_exception,
		const char *	psz_format,
			...
	)

Raise an exception using a user-provided message.

Parameters:

	p_exception	the exception to raise
	psz_format	the exception message format string
	...	the format string arguments

int libvlc_exception_raised

(

const libvlc_exception_t *

p_exception

)

Has an exception been raised?

Parameters:

p_exception

the exception to query

Returns:

0 if the exception was raised, 1 otherwise

---