← Back to branch summary

~ubuntu-branches/ubuntu/natty/evolution-data-server/natty

« back to all changes in this revision

Viewing changes to docs/reference/camel/xml/camel-seekable-stream.xml

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2010-03-01 22:47:15 UTC
  • mfrom: (1.1.77 upstream)
  • Revision ID: james.westby@ubuntu.com-20100301224715-drsxc2y3t8anz3c0
Tags: 2.28.3-0ubuntu1
https://launchpad.net/bugs/455020
https://launchpad.net/bugs/475147
https://launchpad.net/bugs/305428
https://launchpad.net/bugs/341909
https://launchpad.net/bugs/444177
* New upstream version:
  Bug Fixes:
  - #602723 - Contact list name doesn't get displayed in 'To' dialog 
  - #600322 - assertion failed: (reply == msg) in cs_waitinfo()
              (lp: #455020, #475147)
  - #564727 - Few memory leaks (lp: #305428)
  - #574940 - Always ref returned info from message_info_from_uid 
              (lp: #341909)
  - #429317 - Use the relative URI returned if the server 
              re-directs a request
  - #602820 - Test validity of a book_view before using it in LDAP 
  - #590762 - Recurring google calendar items are not changeable
  - #604236 - Slow GPG processing 
  - #597816 - Do not crash on incorrect parameters used in sexp to SQL 
              (lp: #444177)
  - #604544 - Try Exchange fallback authentication only once 
  - #600778 - Fix --enable-e2k-debug configure option resolution 
  - #260407 - 'endswith' address book search doesn't work 
  - #549221 - (bnc) delete, sync flags immediately
* debian/patches/99_reconfigure.patch:
  - new version update

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/camel/xml/camel-seekable-stream.xml
1
 
<refentry id="camel-CamelSeekableStream">
2
 
<refmeta>
3
 
<refentrytitle role="top_of_page" id="camel-CamelSeekableStream.top_of_page">CamelSeekableStream</refentrytitle>
4
 
<manvolnum>3</manvolnum>
5
 
<refmiscinfo>CAMEL Library</refmiscinfo>
6
 
</refmeta>
7
 
 
8
 
<refnamediv>
9
 
<refname>CamelSeekableStream</refname>
10
 
<refpurpose></refpurpose>
11
 
</refnamediv>
12
 
 
13
 
<refsynopsisdiv id="camel-CamelSeekableStream.synopsis" role="synopsis">
14
 
<title role="synopsis.title">Synopsis</title>
15
 
 
16
 
<synopsis>
17
 
struct              <link linkend="CamelSeekableStream">CamelSeekableStream</link>;
18
 
enum                <link linkend="CamelStreamSeekPolicy">CamelStreamSeekPolicy</link>;
19
 
#define             <link linkend="CAMEL-STREAM-UNBOUND--CAPS">CAMEL_STREAM_UNBOUND</link>
20
 
<link linkend="off-t">off_t</link>               <link linkend="camel-seekable-stream-seek">camel_seekable_stream_seek</link>          (<link linkend="CamelSeekableStream">CamelSeekableStream</link> *stream,
21
 
                                                         <link linkend="off-t">off_t</link> offset,
22
 
                                                         <link linkend="CamelStreamSeekPolicy">CamelStreamSeekPolicy</link> policy);
23
 
<link linkend="off-t">off_t</link>               <link linkend="camel-seekable-stream-tell">camel_seekable_stream_tell</link>          (<link linkend="CamelSeekableStream">CamelSeekableStream</link> *stream);
24
 
<link linkend="gint">gint</link>                <link linkend="camel-seekable-stream-set-bounds">camel_seekable_stream_set_bounds</link>    (<link linkend="CamelSeekableStream">CamelSeekableStream</link> *stream,
25
 
                                                         <link linkend="off-t">off_t</link> start,
26
 
                                                         <link linkend="off-t">off_t</link> end);
27
 
</synopsis>
28
 
</refsynopsisdiv>
29
 
 
30
 
 
31
 
 
32
 
 
33
 
 
34
 
 
35
 
 
36
 
 
37
 
 
38
 
<refsect1 id="camel-CamelSeekableStream.description" role="desc">
39
 
<title role="desc.title">Description</title>
40
 
<para>
41
 
</para>
42
 
</refsect1>
43
 
 
44
 
<refsect1 id="camel-CamelSeekableStream.details" role="details">
45
 
<title role="details.title">Details</title>
46
 
<refsect2 id="CamelSeekableStream" role="struct">
47
 
<title>struct CamelSeekableStream</title>
48
 
<indexterm zone="CamelSeekableStream"><primary sortas="CamelSeekableStream">CamelSeekableStream</primary></indexterm><programlisting>struct CamelSeekableStream {
49
 
        CamelStream parent_object;
50
 
 
51
 
        off_t position;         /* current postion in the stream */
52
 
        off_t bound_start;      /* first valid position */
53
 
        off_t bound_end;        /* first invalid position */
54
 
};
55
 
</programlisting>
56
 
<para>
57
 
</para></refsect2>
58
 
<refsect2 id="CamelStreamSeekPolicy" role="enum">
59
 
<title>enum CamelStreamSeekPolicy</title>
60
 
<indexterm zone="CamelStreamSeekPolicy"><primary sortas="CamelStreamSeekPolicy">CamelStreamSeekPolicy</primary></indexterm><programlisting>typedef enum {
61
 
        CAMEL_STREAM_SET = SEEK_SET,
62
 
        CAMEL_STREAM_CUR = SEEK_CUR,
63
 
        CAMEL_STREAM_END = SEEK_END
64
 
} CamelStreamSeekPolicy;
65
 
</programlisting>
66
 
<para>
67
 
</para></refsect2>
68
 
<refsect2 id="CAMEL-STREAM-UNBOUND--CAPS" role="macro">
69
 
<title>CAMEL_STREAM_UNBOUND</title>
70
 
<indexterm zone="CAMEL-STREAM-UNBOUND--CAPS"><primary sortas="CAMEL_STREAM_UNBOUND">CAMEL_STREAM_UNBOUND</primary></indexterm><programlisting>#define CAMEL_STREAM_UNBOUND (~0)
71
 
</programlisting>
72
 
<para>
73
 
</para></refsect2>
74
 
<refsect2 id="camel-seekable-stream-seek" role="function">
75
 
<title>camel_seekable_stream_seek ()</title>
76
 
<indexterm zone="camel-seekable-stream-seek"><primary sortas="camel_seekable_stream_seek">camel_seekable_stream_seek</primary></indexterm><programlisting><link linkend="off-t">off_t</link>               camel_seekable_stream_seek          (<link linkend="CamelSeekableStream">CamelSeekableStream</link> *stream,
77
 
                                                         <link linkend="off-t">off_t</link> offset,
78
 
                                                         <link linkend="CamelStreamSeekPolicy">CamelStreamSeekPolicy</link> policy);</programlisting>
79
 
<para>
80
 
Seek to the specified position in <parameter>stream</parameter>.
81
 
</para>
82
 
<para>
83
 
If <parameter>policy</parameter> is <link linkend="CAMEL-STREAM-SET--CAPS"><type>CAMEL_STREAM_SET</type></link>, seeks to <parameter>offset</parameter>.
84
 
</para>
85
 
<para>
86
 
If <parameter>policy</parameter> is <link linkend="CAMEL-STREAM-CUR--CAPS"><type>CAMEL_STREAM_CUR</type></link>, seeks to the current position plus
87
 
<parameter>offset</parameter>.
88
 
</para>
89
 
<para>
90
 
If <parameter>policy</parameter> is <link linkend="CAMEL-STREAM-END--CAPS"><type>CAMEL_STREAM_END</type></link>, seeks to the end of the stream plus
91
 
<parameter>offset</parameter>.
92
 
</para>
93
 
<para>
94
 
Regardless of <parameter>policy</parameter>, the stream's final position will be clamped
95
 
to the range specified by its lower and upper bounds, and the
96
 
stream's eos state will be updated.</para>
97
 
<para>
98
 
</para><variablelist role="params">
99
 
<varlistentry><term><parameter>stream</parameter>&#160;:</term>
100
 
<listitem><simpara> a <link linkend="CamelStream"><type>CamelStream</type></link> object
101
 
</simpara></listitem></varlistentry>
102
 
<varlistentry><term><parameter>offset</parameter>&#160;:</term>
103
 
<listitem><simpara> offset value
104
 
</simpara></listitem></varlistentry>
105
 
<varlistentry><term><parameter>policy</parameter>&#160;:</term>
106
 
<listitem><simpara> what to do with the offset
107
 
</simpara></listitem></varlistentry>
108
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> new position, <link linkend="1--CAPS"><literal>-1</literal></link> if operation failed.
109
 
</simpara></listitem></varlistentry>
110
 
</variablelist></refsect2>
111
 
<refsect2 id="camel-seekable-stream-tell" role="function">
112
 
<title>camel_seekable_stream_tell ()</title>
113
 
<indexterm zone="camel-seekable-stream-tell"><primary sortas="camel_seekable_stream_tell">camel_seekable_stream_tell</primary></indexterm><programlisting><link linkend="off-t">off_t</link>               camel_seekable_stream_tell          (<link linkend="CamelSeekableStream">CamelSeekableStream</link> *stream);</programlisting>
114
 
<para>
115
 
Get the current position of a seekable stream.</para>
116
 
<para>
117
 
</para><variablelist role="params">
118
 
<varlistentry><term><parameter>stream</parameter>&#160;:</term>
119
 
<listitem><simpara> a <link linkend="CamelSeekableStream"><type>CamelSeekableStream</type></link> object
120
 
</simpara></listitem></varlistentry>
121
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the current position of the stream.
122
 
</simpara></listitem></varlistentry>
123
 
</variablelist></refsect2>
124
 
<refsect2 id="camel-seekable-stream-set-bounds" role="function">
125
 
<title>camel_seekable_stream_set_bounds ()</title>
126
 
<indexterm zone="camel-seekable-stream-set-bounds"><primary sortas="camel_seekable_stream_set_bounds">camel_seekable_stream_set_bounds</primary></indexterm><programlisting><link linkend="gint">gint</link>                camel_seekable_stream_set_bounds    (<link linkend="CamelSeekableStream">CamelSeekableStream</link> *stream,
127
 
                                                         <link linkend="off-t">off_t</link> start,
128
 
                                                         <link linkend="off-t">off_t</link> end);</programlisting>
129
 
<para>
130
 
Set the range of valid data this stream is allowed to cover.  If
131
 
there is to be no <parameter>end</parameter> value, then <parameter>end</parameter> should be set to
132
 
<link linkend="CAMEL-STREAM-UNBOUND--CAPS"><type>CAMEL_STREAM_UNBOUND</type></link>.</para>
133
 
<para>
134
 
</para><variablelist role="params">
135
 
<varlistentry><term><parameter>stream</parameter>&#160;:</term>
136
 
<listitem><simpara> a <link linkend="CamelSeekableStream"><type>CamelSeekableStream</type></link> object
137
 
</simpara></listitem></varlistentry>
138
 
<varlistentry><term><parameter>start</parameter>&#160;:</term>
139
 
<listitem><simpara> the first valid position
140
 
</simpara></listitem></varlistentry>
141
 
<varlistentry><term><parameter>end</parameter>&#160;:</term>
142
 
<listitem><simpara> the first invalid position, or <link linkend="CAMEL-STREAM-UNBOUND--CAPS"><type>CAMEL_STREAM_UNBOUND</type></link>
143
 
</simpara></listitem></varlistentry>
144
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="1--CAPS"><literal>-1</literal></link> on error.
145
 
</simpara></listitem></varlistentry>
146
 
</variablelist></refsect2>
147
 
 
148
 
</refsect1>
149
 
 
150
 
 
151
 
 
152
 
 
153
 
</refentry>