File: egd_get_numch.3

package info (click to toggle)
eegdev 0.2-3
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 4,972 kB
  • sloc: ansic: 32,259; sh: 10,941; makefile: 247; lex: 128; yacc: 118
file content (34 lines) | stat: -rw-r--r-- 947 bytes parent folder | download | duplicates (6)
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
.\"Copyright 2011 (c) EPFL
.TH EGD_GET_NUMCH 3 2011 "EPFL" "EEGDEV library manual"
.SH NAME
egd_get_numch - Get the number of channels sampled by type
.SH SYNOPSIS
.LP
.B #include <eegdev.h>
.sp
.BI "int egd_get_numch(const struct eegdev* " dev ", int " stype ");"
.br
.SH DESCRIPTION
.LP
\fBegd_get_numch\fP() returns the number of channels of type \fIstype\fP
sampled by the recording device referenced by \fIdev\fP. \fIstype\fP must be
one of the values returned by \fBegd_sensor_type\fP(3).
.SH "RETURN VALUE"
.LP
In case of success, the function returns a non negative value corresponding
to the number of channels of type \fIstype\fP (possibly 0 if the device does
not sample this type of data). Otherwise, \-1 is returned and \fIerrno\fP is
set accordingly.
.SH ERRORS
.LP
\fBegd_get_numch\fP() will fail if:
.TP
.B EINVAL
\fIdev\fP is NULL or \fIstype\fP is not valid value.
.SH "SEE ALSO"
.BR egd_get_cap (3),
.BR egd_sensor_type (3)