OSLogArgs

Syntax

#include <cafe/os/OSSystemLog.h>

void OSLogArgs(u32 category, u32 level, u32 options, u32 seqByte,u32 arg0, u32 arg1,
               u32 arg2, u32 arg3);

Parameters

category This argument identifies the category to which the logged event belongs. For more information, see Logging Overview.
level Level at which event is logged. For more information, see Logging Overview.
options Bitmap of options providing metadata about the information being logged. Valid option masks include: OS_LOG_DATA_OPT_ARGC_MASK, OS_LOG_DATA_OPT_FUNC_ENTER_MASK, OS_LOG_DATA_OPT_FUNC_EXIT_MASK, OS_LOG_DATA_OPT_KEY_ARG_MASK. For information, see Logging Overview.
seqByte Sequence byte associated with the logged event. When one wants to trace specific sections of executed logic it can be helpful to repeat the same event, varying only a sequence number. Only the least significant 8-bits of this unsigned argument are valid at this time.
arg0 The first of four argument words. When OS_LOG_DATA_OPT_KEY_ARG_MASK is specified within options, this argument is assumed to be four 8-bit ASCII characters which are treated as a keyword when the log is displayed.
arg1 The second of four argument words.
arg2 The third of four argument words.
arg3 The fourth and final argument word.

Return Values

None.

Description

Logs four user-specified argument words. arg0 has special meaning when the OS_LOG_DATA_OPT_KEY_ARG_MASK option is applied. This function is guaranteed to consume the least amount of memory in the log, since it submits a limited amount of data.

Do Not Call From

None.

See Also

System Logging Overview
APP_TRACE_* Macros
OSLogBuffer
OSLogFunc
OSLogPrintf
OSLogReport
OSLogRetrieve
OSLogSaveCrashDump
OSLogSetFilterPolicy

Revision History

2015/03/11 Various style fixes.
2013/05/08 Automated cleanup pass.
2012/08/02 Cleanup Pass.
2012/05/23 Initial version.


CONFIDENTIAL