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

« back to all changes in this revision

Viewing changes to doc/man/comedi_do_insnlist.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_DO_INSNLIST" "3" "02 October 2004" "" ""
 
7
 
 
8
.SH NAME
 
9
comedi_do_insnlist \- perform multiple instructions
 
10
.SH SYNOPSIS
 
11
.sp
 
12
\fB#include <comedilib.h>
 
13
.sp
 
14
int comedi_do_insnlist (comedi_t * \fIdevice\fB, comedi_insnlist * \fIlist\fB);
 
15
\fR
 
16
.SH "DESCRIPTION"
 
17
.PP
 
18
The function comedi_do_insnlist() performs multiple Comedi
 
19
instructions as part of one system call.  In addition, Comedi
 
20
attempts to perform the instructions atomically, that is, on
 
21
standard Linux kernels, no process preemption should occur
 
22
during the instructions.  However, the process may be preempted
 
23
before or after the group of instructions.
 
24
.PP
 
25
This function can be used to avoid the overhead of multiple
 
26
system calls, or to ensure that multiple instructions occur
 
27
without significant delay between them.
 
28
Preemption may occur if any of the instructions or the data
 
29
arrays of any of the instructions exist in non-resident or
 
30
copy-on-write pages.
 
31
.SH "RETURN VALUE"
 
32
.PP
 
33
The function comedi_do_insnlist() returns the number of
 
34
sucessfully completed instructions.  Error information for
 
35
the unsucessful instruction is not available.  If there is
 
36
an error before the first instruction can be executed, -1
 
37
is returned.
 
38
.PP