~ubuntu-branches/ubuntu/intrepid/comedilib/intrepid

« back to all changes in this revision

Viewing changes to doc/man/comedi_set_global_oor_behavior.3

  • Committer: Bazaar Package Importer
  • Author(s): David Schleef
  • Date: 2004-11-04 11:43:51 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20041104114351-a50kaei5yamka8r6
Tags: 0.7.22-2
It helps if the shared library is actually in the package.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.\" This manpage has been automatically generated by docbook2man 
 
2
.\" from a DocBook document.  This tool can be found at:
 
3
.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> 
 
4
.\" Please send any bug reports, improvements, comments, patches, 
 
5
.\" etc. to Steve Cheng <steve@ggi-project.org>.
 
6
.TH "COMEDI_SET_GLOBAL_OOR_BEHAVIOR" "3" "02 October 2004" "" ""
 
7
 
 
8
.SH NAME
 
9
comedi_set_global_oor_behavior \- out-of-range behavior
 
10
.SH SYNOPSIS
 
11
.sp
 
12
\fB#include <comedilib.h>
 
13
.sp
 
14
int comedi_set_global_oor_behavior (enum comedi_oor_behavior \fIbehavior\fB);
 
15
\fR
 
16
.SH "STATUS"
 
17
.PP
 
18
alpha
 
19
.SH "DESCRIPTION"
 
20
.PP
 
21
This function changes the Comedilib out-of-range behavior.
 
22
This currently affects the behavior of comedi_to_phys() when
 
23
converting endpoint sample values, that is, sample values
 
24
equal to 0 or maxdata.  If the out-of-range behavior is set to
 
25
COMEDI_OOR_NAN, endpoint values are converted to NAN.  If the
 
26
out-of-range behavior is set to COMEDI_OOR_NUMBER, the endpoint
 
27
values are converted similarly to other values.
 
28
.PP
 
29
The previous out-of-range behavior is returned.
 
30
.PP