Assertion evaluation
[Debugging Mechanisms]

Assertion evaluation. More...

Defines

• #define HEL_ASSERT(expression, message)

  Assertion evaluation mechanism.
  

• #define HEL_SASSERT(expression)

  Static assertion evaluation mechanism.
  

Functions

• HEL_API void
  ATTR_NOINSTRUMENT hel_DebugSetOnAssert (PDebugAssertFunc pFunc)

  Specify a function that gets called before an assertion takes place.
  

---

Detailed Description

Assertion evaluation.

---

Define Documentation

#define HEL_ASSERT	(	expression,
		message		)

Assertion evaluation mechanism.

The HEL_ASSERT mechanism evaluates an expression and, when the result is FALSE, displays an error screen and aborts the program execution until you press a specific button. The error-screen displays several informations where in the source the assertion failed. This includes:

• Filename
• Line
• Function
• Expression
• Description

Assertion Screen

Assertion Screen displaying the call stack

Parameters:

[in]	expression	Expression that evaluates to TRUE or FALSE
[in]	message	Message to display when expression is FALSE

Note:

The HEL_ASSERT macro is typically used to identify logic errors during program development by implementing the expression argument to evaluate to FALSE only when the program is operating incorrectly.

HEL_ASSERT works only in HEL_DEBUG and HEL_CHECKED versions.

See also:

hel_DebugSetOnAssert, Library Overview

#define HEL_SASSERT

(

expression

)

Static assertion evaluation mechanism.

The HEL_SASSERT macro can be used to evaluate an expression at compile time.

Parameters:

[in]

expression

Expression that evaluates to TRUE or FALSE

Note:

HEL_SASSERT works in all HEL versions, HEL_DEBUG, HEL_CHECKED and in release mode.

---

Function Documentation

HEL_API void ATTR_NOINSTRUMENT hel_DebugSetOnAssert

(

PDebugAssertFunc

pFunc

)

Specify a function that gets called before an assertion takes place.

You can specify a function that gets called before an assertion takes place. This can be helpful if you want to output your engine stats or whatever when something went wrong. Use the hel_DebugSetOnAssert function for this.

Parameters:

[in]

pFunc

A pointer to the function that should be called before an assertion takes place

---