linuxcnc/docs/man/man3/rtapi_task_self.3rtapi
Jeff Epler 1ff8d47e9d rtapi: document that rtapi_task_self may be called from init/cleanup
.. and that it will return -EINVAL in this state

Signed-off-by: Jeff Epler <jepler@unpythonic.net>
2015-04-18 21:22:06 -05:00

21 lines
544 B
Text

.TH rtapi_task_self "3rtapi" "2015-04-18" "LinuxCNC Documentation" "RTAPI"
.SH NAME
rtapi_task_self \- Retrieve ID of current task
.SH SYNTAX
.HP
void rtapi_task_self()
.SH DESCRIPTION
\fBrtapi_task_self\fR retrieves the current task, or -EINVAL if not in a
realtime task (e.g., in startup or shutdown code).
.SH REALTIME CONSIDERATIONS
May be called from init/cleanup code, and from within realtime tasks.
.SH RETURN VALUE
The task number previously returned by \fBrtapi_task_new\fR or -EINVAL.
.SH SEE ALSO
\fBrtapi_task_new(3rtapi)\fR