IEvFatalMessage Class Reference

Event occurs on engine fatal error. More...

#include <DGLE.h>

Inheritance diagram for IEvFatalMessage:

Public Member Functions
virtual DGLE_RESULT DGLE_API	GetMessageText (char *pcTxt, uint &uiCharsCount)=0
	Returns the fatal message text.
virtual DGLE_RESULT DGLE_API	FreezeEngine (bool bFreeze)=0
	Suspends all engine threads and pauses all engine routines.
virtual DGLE_RESULT DGLE_API	ForceNoMessage ()=0
	Forces engine not to show error message and console.
virtual DGLE_RESULT DGLE_API	ForceIgnoreError ()=0
	Forces engine to ignore current error and tries to continue.
Public Member Functions inherited from IBaseEvent
virtual DGLE_RESULT DGLE_API	GetEventType (E_EVENT_TYPE &eEvType)=0
	Returns type of event.
virtual DGLE_RESULT DGLE_API	GetUnknownEventType (uint &uiUnknEvType)=0
	In case event type is ET_UNKNOWN, you can use this function to get specific event type id.
Public Member Functions inherited from IDGLE_Base
virtual DGLE_RESULT DGLE_API	GetGUID (GUID &guid)=0
	Returns unique identifier of the last interface in the inheritance chain.
virtual DGLE_RESULT DGLE_API	ExecuteCommand (uint uiCmd, TVariant &stVar)=0
	Executes some command using its index or bitmask.
virtual DGLE_RESULT DGLE_API	ExecuteTextCommand (const char *pcCommand, TVariant &stVar)=0
	Executes some text command and returns result as variant.
virtual DGLE_RESULT DGLE_API	ExecuteTextCommandEx (const char *pcCommand, char *pcResult, uint &uiCharsCount)=0
	Executes some text command and returns result as string.

Detailed Description

Event occurs on engine fatal error.

Also application errors such as "Access Violation" are handled by this event if EIF_CATCH_UNHANDLED flag is set in IEngineCore::InitializeEngine initialization flags. By handling this event

See Also

ET_ON_ENGINE_FATAL_MESSAGE, LT_FATAL, IBaseEvent

Member Function Documentation

virtual DGLE_RESULT DGLE_API ForceIgnoreError ( )

pure virtual

Forces engine to ignore current error and tries to continue.

Warning

Use with care.

virtual DGLE_RESULT DGLE_API ForceNoMessage ( )

pure virtual

Forces engine not to show error message and console.

Note

If you decided not to show error message you should inform user about error somehow.

virtual DGLE_RESULT DGLE_API FreezeEngine ( bool  bFreeze )

pure virtual

Suspends all engine threads and pauses all engine routines.

Parameters

[in]

bFreeze

Suspends if true or resumes if false engine threads and routines.

virtual DGLE_RESULT DGLE_API GetMessageText ( char *  pcTxt, uint &  uiCharsCount  )

pure virtual

Returns the fatal message text.

Parameters

[out]	pcTxt	Pointer to allocated string.
[in,out]	uiCharsCount	Count of the chars in allocated string.

Returns

E_INVALIDARG must be returned if allocated string is too small.

Note

If pcTxt is NULL then uiCharsCount will contain the length of the text to allocate.