1  .TH funct "3hal" "2006-10-12" "LinuxCNC Documentation" "HAL"
 2  .SH NAME
 3  
 4  hal_ready \- indicates that this component is ready
 5  
 6  .SH SYNTAX
 7  .HP
 8   hal_ready(int \fIcomp_id\fR)
 9  
10  .SH  ARGUMENTS
11  .IP \fIcomp_id\fR
12  A HAL component identifier returned by an earlier call to \fBhal_init\fR.
13  
14  .SH DESCRIPTION
15  \fBhal_ready\fR indicates that this component is ready (has created all its pins,
16  parameters, and functions).  This must be called in any realtime HAL component
17  before its \fBrtapi_app_init\fR exits, and in any userspace component before it
18  enters its main loop.
19  
20  .SH RETURN VALUE
21  Returns a HAL status code.