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
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
|
.TH NJB_CAPTURE 3 "March 2001"
.SH NAME
NJB_Capture, NJB_Release \- Capture or release an NJB
.SH LIBRARY
libnjb
.SH SYNOPSIS
#include <libnjb.h>
extern int njb_error
NJB_Capture (njb_t
.BR *njb )
NJB_Release (njb_t
.BR *njb )
.SH DESCRIPTION
The NJB_Capture function "captures" the NJB device, which locks out
the control buttons on the device itself. Any attempt to use the NJB
controls directly will result in a "HOST IS IN CONTROL" message on the
LCD screen.
Capturing the NJB is an essential part of the session, since you want
to ensure that only the controlling software can modify the contents
of the device.
.B *njb
must be an njb object that was previously opened via
.BR NJB_Open (3).
To release the NJB, use the NJB_Release command.
.SH RETURN VALUES
Both functions return 0 upon success, and return -1 and set
.B njb_error
on failure:
.LP
.TP 10
EO_USBCTL
An I/O error occured when speaking on the control pipe
.TP 10
EO_BADSTATUS
The NJB returned a "failure" status in response to the capture or
release command.
.LP
.SH SEE ALSO
NJB_Open(3)
|
