linuxcnc/docs/man/man3/rtapi_set_msg_level.3rtapi
andypugh 07dcd21111 rtapi: add a halcmd command to set the messaging level
Signed-off-by: andypugh <andy@bodgesoc.org>
2020-06-11 23:05:45 +01:00

36 lines
873 B
Text

.TH rtapi_set_msg_level "3rtapi" "2006-10-12" "LinuxCNC Documentation" "RTAPI"
.SH NAME
rtapi_get_msg_level, rtapi_set_msg_level \- Get or set the logging level
.SH SYNTAX
.HP
int rtapi_set_msg_level(int \fIlevel\fR)
.HP
int rtapi_get_msg_level()
.SH ARGUMENTS
.IP \fIlevel\fR
The desired logging level
.SH DESCRIPTION
Get or set the RTAPI message level used by \fBrtapi_print_msg\fR. Depending
on the RTOS, this level may apply to a single RTAPI module, or it may apply
to a group of modules.
.SH REALTIME CONSIDERATIONS
May be called from user, init/cleanup, and realtime code.
.SH RETURN VALUE
\fBrtapi_set_msg_level\fR returns a status code, and \fBrtapi_get_msg_level\fR
returns the current level.
RTAPI_MSG_NONE = 0,
RTAPI_MSG_ERR = 1,
RTAPI_MSG_WARN = 2,
RTAPI_MSG_INFO = 3,
RTAPI_MSG_DBG = 4
RTAPI_MSG_ALL = 5
.SH SEE ALSO
\fBrtapi_print_msg(3rtapi)\fR