<?xml version="1.0" encoding="ANSI_X3.4-1968" standalone="no"?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=ANSI_X3.4-1968" /><title>seq_open</title><meta name="generator" content="DocBook XSL Stylesheets V1.78.1" /><link rel="home" href="index.html" title="Linux Filesystems API" /><link rel="up" href="other_functions.html" title="Other Functions" /><link rel="prev" href="API-bioset-create.html" title="bioset_create" /><link rel="next" href="API-seq-read.html" title="seq_read" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center"><span class="phrase">seq_open</span></th></tr><tr><td width="20%" align="left"><a accesskey="p" href="API-bioset-create.html">Prev</a> </td><th width="60%" align="center">Other Functions</th><td width="20%" align="right"> <a accesskey="n" href="API-seq-read.html">Next</a></td></tr></table><hr /></div><div class="refentry"><a id="API-seq-open"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>seq_open — initialize sequential file </p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="funcsynopsis"><table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr><td><code class="funcdef">int <strong class="fsfunc">seq_open </strong>(</code></td><td>struct file * <var class="pdparam">file</var>, </td></tr><tr><td> </td><td>const struct seq_operations * <var class="pdparam">op</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div></div><div class="refsect1"><a id="idm139881794723920"></a><h2>Arguments</h2><div class="variablelist"><dl class="variablelist"><dt><span class="term"><em class="parameter"><code>file</code></em></span></dt><dd><p> file we initialize </p></dd><dt><span class="term"><em class="parameter"><code>op</code></em></span></dt><dd><p> method table describing the sequence </p></dd></dl></div></div><div class="refsect1"><a id="idm139881794718720"></a><h2>Description</h2><p> <code class="function">seq_open</code> sets <em class="parameter"><code>file</code></em>, associating it with a sequence described by <em class="parameter"><code>op</code></em>. <em class="parameter"><code>op</code></em>-><code class="function">start</code> sets the iterator up and returns the first element of sequence. <em class="parameter"><code>op</code></em>-><code class="function">stop</code> shuts it down. <em class="parameter"><code>op</code></em>-><code class="function">next</code> returns the next element of sequence. <em class="parameter"><code>op</code></em>-><code class="function">show</code> prints element into the buffer. In case of error -><code class="function">start</code> and -><code class="function">next</code> return ERR_PTR(error). In the end of sequence they return <code class="constant">NULL</code>. -><code class="function">show</code> returns 0 in case of success and negative number in case of error. Returning SEQ_SKIP means <span class="quote">“<span class="quote">discard this element and move on</span>”</span>. </p></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="API-bioset-create.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="other_functions.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="API-seq-read.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top"><span class="phrase">bioset_create</span> </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> <span class="phrase">seq_read</span></td></tr></table></div></body></html>