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

« back to all changes in this revision

Viewing changes to doc/man/comedi_get_cmd_generic_timed.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_GET_CMD_GENERIC_TIMED" "3" "02 October 2004" "" ""
 
7
 
 
8
.SH NAME
 
9
comedi_get_cmd_generic_timed \- streaming input/output capabilities
 
10
.SH SYNOPSIS
 
11
.sp
 
12
\fB#include <comedilib.h>
 
13
.sp
 
14
int comedi_get_cmd_generic_timed (comedi_t * \fIdevice\fB, unsigned int \fIsubdevice\fB, comedi_cmd * \fIcommand\fB, unsigned int \fIperiod_ns\fB);
 
15
\fR
 
16
.SH "DESCRIPTION"
 
17
.PP
 
18
The command capabilities of the subdevice indicated by the parameters
 
19
device and subdevice are probed, and the results placed in the
 
20
command structure pointed to by the parameter command.  The command
 
21
structure pointed to by the parameter command is modified to be a
 
22
valid command that can be used as a parameter to comedi_command().
 
23
The command measures samples at a rate that corresponds to the
 
24
period period_ns.  The rate is adjusted to a rate that the device
 
25
can handle.  If sucessful, 0 is returned, otherwise -1.
 
26
.PP