1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
|
.TH hal_init "3hal" "2006-10-12" "LinuxCNC Documentation" "HAL"
.SH NAME
hal_init \- Sets up HAL and RTAPI
.SH SYNTAX
.HP
int hal_init(const char *\fImodname\fR)
.SH ARGUMENTS
.IP \fImodname\fR
The name of this HAL module
.SH DESCRIPTION
\fBhal_init\fR sets up HAL and RTAPI. It must be called by any
module that intends to use the API, before any other RTAPI
calls.
\fImodname\fR must point to a string that identifies the module.
The string may be no longer than \fBHAL_NAME_LEN\fR characters.
.SH REALTIME CONSIDERATIONS
Call only from within non-realtime or init/cleanup code, not from realtime tasks.
.SH RETURN VALUE
On success, returns a positive integer module ID, which is
used for subsequent calls to HAL and rtapi APIs.
On failure, returns a HAL error code.
|
