Error Handling

This category contains functions for handling errors. More...

Functions

Type	Name
fpl_common_api void	fplErrorsClear (void) Clears all the current errors in the platform.
fpl_common_api const char *	fplGetErrorByIndex (const size_t index) Gets the last error string from the given index.
fpl_common_api size_t	fplGetErrorCount (void) Gets the count of total last errors.
fpl_common_api const char *	fplGetLastError (void) Gets the last internal error string.

Detailed Description

This category contains functions for handling errors.

Function Documentation

fplErrorsClear()

fpl_common_api void fplErrorsClear ( void )

Clears all the current errors in the platform.

Note: This function can be called regardless of the initialization state!

See also: Clearing the errors

fplGetErrorByIndex()

fpl_common_api const char * fplGetErrorByIndex ( const size_t index)

Gets the last error string from the given index.

Parameters

Direction	Parameter	Description
[in]	index	The index of the error.

Returns: Returns the last error string from the given index or an empty string when there was no error.

Note: This function can be called regardless of the initialization state!

See also: Get error by index

fplGetErrorCount()

fpl_common_api size_t fplGetErrorCount ( void )

Gets the count of total last errors.

Returns: Returns the number of last errors or zero when there was no error.

Note: This function can be called regardless of the initialization state!

See also: Was there an error?

fplGetLastError()

fpl_common_api const char * fplGetLastError ( void )

Gets the last internal error string.

Returns: Returns the last error string or an empty string when there was no error.

Note: This function can be called regardless of the initialization state!

See also: Get latest error