Share via

OALMSG (Compact 2013)

  • Article

10/16/2014

This macro is used to log messages in the OAL.

Syntax

#define OALMSG(cond, exp)

Parameters

  • cond
    Boolean value that specifies whether the trace will occur. Use a value representing an OAL trace zone to set the cond parameter.

    See OAL Trace Zones for descriptions of the valid trace zones. The trace zones can be combined in this argument using Boolean operators. If this parameter resolves to TRUE, the trace will occur. If it resolves to FALSE, the trace will not occur.

  • exp
    Expression to be passed to OALLog if the cond parameter is set to TRUE. OALLog is implemented by a trace routine function in the kernel.

Return Value

None.

Remarks

OALZONE is automatically called for each trace zone specified in the exp parameter.

This macro is deactivated if the SHIPBUILD constant is defined.

An error occurs if OALMSG is called by a function on the KITL stack. OALMSGS must be called instead.

Any API that is included in the OEMGLOBAL structure will be present on the KITL stack, although only a subset of these APIs will be in use. This structure is defined in Oemglob.h.

Requirements

Header

oal_log.h

See Also

Reference

Logging Macros