File: rtapi_exit.3rtapi

package info (click to toggle)
linuxcnc 1%3A2.9.7-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 285,604 kB
  • sloc: python: 202,568; ansic: 109,036; cpp: 99,239; tcl: 16,054; xml: 10,631; sh: 10,303; makefile: 1,255; javascript: 138; sql: 72; asm: 15
file content (23 lines) | stat: -rw-r--r-- 589 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
.TH rtapi_exit "3rtapi" "2006-10-12" "LinuxCNC Documentation" "RTAPI"
.SH NAME

rtapi_exit \- Shut down RTAPI

.SH SYNTAX
.HP
 int rtapi_exit(int \fImodule_id\fR)

.SH ARGUMENTS
.IP \fImodule_id\fR
An rtapi module identifier returned by an earlier call to \fBrtapi_init\fR.

.SH DESCRIPTION
\fBrtapi_exit\fR shuts down and cleans up the RTAPI.  It must be
called prior to exit by any module that called \fBrtapi_init\fR.

.SH REALTIME CONSIDERATIONS
Call only from within non-realtime or realtime init/cleanup code, not from realtime tasks.

.SH RETURN VALUE
Returns a RTAPI status code.