Elaztek Developer Hub
Blamite Game Engine - blam!  00406.12.10.23.1457.blamite
The core library for the Blamite Game Engine.
Blam::Diagnostics::Errors Namespace Reference

Namespace containing functions relating to error information and reporting. More...

Functions

BLAM void RegisterSignalExceptions ()
 Registers all signal handlers. More...
 
BLAM void ShowLastErrorInfo (const char *function, BlamErrorDisplayType display_type)
 Displays the last error information from the Windows APIs. More...
 
BLAM int ShowErrorDialog (std::string message, BlamResult error, bool allow_continue, bool allow_safemode)
 Shows an Error dialog with the specified error details and result handle. More...
 
BLAM int ShowWin32ErrorDialog (std::string message, BlamResult error, bool allow_continue, bool allow_safemode)
 Shows an Error dialog with the specified error details and result handle. More...
 

Detailed Description

Namespace containing functions relating to error information and reporting.

Function Documentation

◆ RegisterSignalExceptions()

void Blam::Diagnostics::Errors::RegisterSignalExceptions ( )

Registers all signal handlers.

After this is called, signal exceptions will be thrown or handled by the engine.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ ShowErrorDialog()

int Blam::Diagnostics::Errors::ShowErrorDialog ( std::string  message,
BlamResult  error,
bool  allow_continue,
bool  allow_safemode 
)

Shows an Error dialog with the specified error details and result handle.

This can be used to show a more descriptive message along with an error code for debugging.

Parameters
message- The detailed message to show.
error- The BlamResult code of the reported error.
allow_continue- Whether or not to allow the user to try to continue.
allow_safemoed- Whether or not to allow the user to try to continue in Safe Mode.
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ ShowLastErrorInfo()

void Blam::Diagnostics::Errors::ShowLastErrorInfo ( const char *  function,
BlamErrorDisplayType  display_type 
)

Displays the last error information from the Windows APIs.

Parameters
function- The function that was last called, ex: TEXT("LoadCursorW")
display_type- The error display type. See BlamErrorDisplayType for details.
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ ShowWin32ErrorDialog()

int Blam::Diagnostics::Errors::ShowWin32ErrorDialog ( std::string  message,
BlamResult  error,
bool  allow_continue,
bool  allow_safemode 
)

Shows an Error dialog with the specified error details and result handle.

This can be used to show a more descriptive message along with an error code for debugging.

This function will explicitly use the Win32 error dialog, regardless of configuration setting. This can be used in the event that early startup errors occur before any other error dialog display type is usable.

Parameters
message- The detailed message to show.
hr- The BlamResult code of the reported error.
allow_continue- Whether or not to allow the user to try to continue.
allow_safemoed- Whether or not to allow the user to try to continue in Safe Mode.
+ Here is the call graph for this function:
+ Here is the caller graph for this function: