← Back to branch summary

~ubuntu-branches/ubuntu/vivid/emscripten/vivid

« back to all changes in this revision

Viewing changes to tests/poppler/glib/reference/html/PopplerAttachment.html

  • Committer: Package Import Robot
  • Author(s): Sylvestre Ledru
  • Date: 2013-05-02 13:11:51 UTC
  • Revision ID: package-import@ubuntu.com-20130502131151-q8dvteqr1ef2x7xz
Tags: upstream-1.4.1~20130504~adb56cb
Import upstream version 1.4.1~20130504~adb56cb

Show diffs side-by-side

added added

removed removed

Lines of Context:
tests/poppler/glib/reference/html/PopplerAttachment.html
 
1
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
 
2
<html>
 
3
<head>
 
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 
5
<title>PopplerAttachment</title>
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
 
7
<link rel="home" href="index.html" title="Poppler Reference Manual">
 
8
<link rel="up" href="ch01.html" title="Poppler">
 
9
<link rel="prev" href="poppler-PopplerAction.html" title="PopplerAction">
 
10
<link rel="next" href="PopplerFormField.html" title="PoppplerFormField">
 
11
<meta name="generator" content="GTK-Doc V1.17 (XML mode)">
 
12
<link rel="stylesheet" href="style.css" type="text/css">
 
13
</head>
 
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
 
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
 
16
<tr valign="middle">
 
17
<td><a accesskey="p" href="poppler-PopplerAction.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
 
18
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
 
19
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
 
20
<th width="100%" align="center">Poppler Reference Manual</th>
 
21
<td><a accesskey="n" href="PopplerFormField.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
 
22
</tr>
 
23
<tr><td colspan="5" class="shortcuts">
 
24
<a href="#PopplerAttachment.synopsis" class="shortcut">Top</a>
 
25
                   | 
 
26
                  <a href="#PopplerAttachment.description" class="shortcut">Description</a>
 
27
                   | 
 
28
                  <a href="#PopplerAttachment.object-hierarchy" class="shortcut">Object Hierarchy</a>
 
29
</td></tr>
 
30
</table>
 
31
<div class="refentry">
 
32
<a name="PopplerAttachment"></a><div class="titlepage"></div>
 
33
<div class="refnamediv"><table width="100%"><tr>
 
34
<td valign="top">
 
35
<h2><span class="refentrytitle"><a name="PopplerAttachment.top_of_page"></a>PopplerAttachment</span></h2>
 
36
<p>PopplerAttachment — Attachments</p>
 
37
</td>
 
38
<td valign="top" align="right"></td>
 
39
</tr></table></div>
 
40
<div class="refsynopsisdiv">
 
41
<a name="PopplerAttachment.synopsis"></a><h2>Synopsis</h2>
 
42
<pre class="synopsis">
 
43
#include &lt;poppler.h&gt;
 
44
 
 
45
                    <a class="link" href="PopplerAttachment.html#PopplerAttachment-struct" title="PopplerAttachment">PopplerAttachment</a>;
 
46
<span class="returnvalue">gboolean</span>            (<a class="link" href="PopplerAttachment.html#PopplerAttachmentSaveFunc" title="PopplerAttachmentSaveFunc ()">*PopplerAttachmentSaveFunc</a>)        (<em class="parameter"><code>const <span class="type">gchar</span> *buf</code></em>,
 
47
                                                         <em class="parameter"><code><span class="type">gsize</span> count</code></em>,
 
48
                                                         <em class="parameter"><code><span class="type">gpointer</span> data</code></em>,
 
49
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
 
50
<span class="returnvalue">gboolean</span>            <a class="link" href="PopplerAttachment.html#poppler-attachment-save" title="poppler_attachment_save ()">poppler_attachment_save</a>             (<em class="parameter"><code><a class="link" href="PopplerAttachment.html" title="PopplerAttachment"><span class="type">PopplerAttachment</span></a> *attachment</code></em>,
 
51
                                                         <em class="parameter"><code>const <span class="type">char</span> *filename</code></em>,
 
52
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
 
53
<span class="returnvalue">gboolean</span>            <a class="link" href="PopplerAttachment.html#poppler-attachment-save-to-callback" title="poppler_attachment_save_to_callback ()">poppler_attachment_save_to_callback</a> (<em class="parameter"><code><a class="link" href="PopplerAttachment.html" title="PopplerAttachment"><span class="type">PopplerAttachment</span></a> *attachment</code></em>,
 
54
                                                         <em class="parameter"><code><a class="link" href="PopplerAttachment.html#PopplerAttachmentSaveFunc" title="PopplerAttachmentSaveFunc ()"><span class="type">PopplerAttachmentSaveFunc</span></a> save_func</code></em>,
 
55
                                                         <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>,
 
56
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
 
57
</pre>
 
58
</div>
 
59
<div class="refsect1">
 
60
<a name="PopplerAttachment.object-hierarchy"></a><h2>Object Hierarchy</h2>
 
61
<pre class="synopsis">
 
62
  GObject
 
63
   +----PopplerAttachment
 
64
</pre>
 
65
</div>
 
66
<div class="refsect1">
 
67
<a name="PopplerAttachment.description"></a><h2>Description</h2>
 
68
</div>
 
69
<div class="refsect1">
 
70
<a name="PopplerAttachment.details"></a><h2>Details</h2>
 
71
<div class="refsect2">
 
72
<a name="PopplerAttachment-struct"></a><h3>PopplerAttachment</h3>
 
73
<pre class="programlisting">typedef struct _PopplerAttachment PopplerAttachment;</pre>
 
74
</div>
 
75
<hr>
 
76
<div class="refsect2">
 
77
<a name="PopplerAttachmentSaveFunc"></a><h3>PopplerAttachmentSaveFunc ()</h3>
 
78
<pre class="programlisting"><span class="returnvalue">gboolean</span>            (*PopplerAttachmentSaveFunc)        (<em class="parameter"><code>const <span class="type">gchar</span> *buf</code></em>,
 
79
                                                         <em class="parameter"><code><span class="type">gsize</span> count</code></em>,
 
80
                                                         <em class="parameter"><code><span class="type">gpointer</span> data</code></em>,
 
81
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
 
82
<p>
 
83
Specifies the type of the function passed to
 
84
<a class="link" href="PopplerAttachment.html#poppler-attachment-save-to-callback" title="poppler_attachment_save_to_callback ()"><code class="function">poppler_attachment_save_to_callback()</code></a>.  It is called once for each block of
 
85
bytes that is "written" by <a class="link" href="PopplerAttachment.html#poppler-attachment-save-to-callback" title="poppler_attachment_save_to_callback ()"><code class="function">poppler_attachment_save_to_callback()</code></a>.  If
 
86
successful it should return <code class="literal">TRUE</code>.  If an error occurs it should set
 
87
<em class="parameter"><code>error</code></em> and return <code class="literal">FALSE</code>, in which case <a class="link" href="PopplerAttachment.html#poppler-attachment-save-to-callback" title="poppler_attachment_save_to_callback ()"><code class="function">poppler_attachment_save_to_callback()</code></a>
 
88
will fail with the same error.
 
89
</p>
 
90
<p>
 
91
<em class="parameter"><code>Returns</code></em>: <code class="literal">TRUE</code> if successful, <code class="literal">FALSE</code> (with <em class="parameter"><code>error</code></em> set) if failed.
 
92
</p>
 
93
<div class="variablelist"><table border="0">
 
94
<col align="left" valign="top">
 
95
<tbody>
 
96
<tr>
 
97
<td><p><span class="term"><em class="parameter"><code>buf</code></em> :</span></p></td>
 
98
<td>buffer containing bytes to be written.</td>
 
99
</tr>
 
100
<tr>
 
101
<td><p><span class="term"><em class="parameter"><code>count</code></em> :</span></p></td>
 
102
<td>number of bytes in <em class="parameter"><code>buf</code></em>.</td>
 
103
</tr>
 
104
<tr>
 
105
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
 
106
<td>user data passed to <a class="link" href="PopplerAttachment.html#poppler-attachment-save-to-callback" title="poppler_attachment_save_to_callback ()"><code class="function">poppler_attachment_save_to_callback()</code></a>
 
107
</td>
 
108
</tr>
 
109
<tr>
 
110
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
 
111
<td>GError to set on error, or NULL</td>
 
112
</tr>
 
113
</tbody>
 
114
</table></div>
 
115
</div>
 
116
<hr>
 
117
<div class="refsect2">
 
118
<a name="poppler-attachment-save"></a><h3>poppler_attachment_save ()</h3>
 
119
<pre class="programlisting"><span class="returnvalue">gboolean</span>            poppler_attachment_save             (<em class="parameter"><code><a class="link" href="PopplerAttachment.html" title="PopplerAttachment"><span class="type">PopplerAttachment</span></a> *attachment</code></em>,
 
120
                                                         <em class="parameter"><code>const <span class="type">char</span> *filename</code></em>,
 
121
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
 
122
<p>
 
123
Saves <em class="parameter"><code>attachment</code></em> to a file indicated by <em class="parameter"><code>filename</code></em>.  If <em class="parameter"><code>error</code></em> is set, <code class="literal">FALSE</code>
 
124
will be returned. Possible errors include those in the <span class="type">G_FILE_ERROR</span> domain
 
125
and whatever the save function generates.
 
126
</p>
 
127
<div class="variablelist"><table border="0">
 
128
<col align="left" valign="top">
 
129
<tbody>
 
130
<tr>
 
131
<td><p><span class="term"><em class="parameter"><code>attachment</code></em> :</span></p></td>
 
132
<td>A <a class="link" href="PopplerAttachment.html" title="PopplerAttachment"><span class="type">PopplerAttachment</span></a>.</td>
 
133
</tr>
 
134
<tr>
 
135
<td><p><span class="term"><em class="parameter"><code>filename</code></em> :</span></p></td>
 
136
<td>name of file to save</td>
 
137
</tr>
 
138
<tr>
 
139
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
 
140
<td>return location for error, or <code class="literal">NULL</code>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
 
141
</td>
 
142
</tr>
 
143
<tr>
 
144
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
145
<td>
 
146
<code class="literal">TRUE</code>, if the file successfully saved</td>
 
147
</tr>
 
148
</tbody>
 
149
</table></div>
 
150
</div>
 
151
<hr>
 
152
<div class="refsect2">
 
153
<a name="poppler-attachment-save-to-callback"></a><h3>poppler_attachment_save_to_callback ()</h3>
 
154
<pre class="programlisting"><span class="returnvalue">gboolean</span>            poppler_attachment_save_to_callback (<em class="parameter"><code><a class="link" href="PopplerAttachment.html" title="PopplerAttachment"><span class="type">PopplerAttachment</span></a> *attachment</code></em>,
 
155
                                                         <em class="parameter"><code><a class="link" href="PopplerAttachment.html#PopplerAttachmentSaveFunc" title="PopplerAttachmentSaveFunc ()"><span class="type">PopplerAttachmentSaveFunc</span></a> save_func</code></em>,
 
156
                                                         <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>,
 
157
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
 
158
<p>
 
159
Saves <em class="parameter"><code>attachment</code></em> by feeding the produced data to <em class="parameter"><code>save_func</code></em>. Can be used
 
160
when you want to store the attachment to something other than a file, such as
 
161
an in-memory buffer or a socket. If <em class="parameter"><code>error</code></em> is set, <code class="literal">FALSE</code> will be
 
162
returned. Possible errors include those in the <span class="type">G_FILE_ERROR</span> domain and
 
163
whatever the save function generates.
 
164
</p>
 
165
<div class="variablelist"><table border="0">
 
166
<col align="left" valign="top">
 
167
<tbody>
 
168
<tr>
 
169
<td><p><span class="term"><em class="parameter"><code>attachment</code></em> :</span></p></td>
 
170
<td>A <a class="link" href="PopplerAttachment.html" title="PopplerAttachment"><span class="type">PopplerAttachment</span></a>.</td>
 
171
</tr>
 
172
<tr>
 
173
<td><p><span class="term"><em class="parameter"><code>save_func</code></em> :</span></p></td>
 
174
<td>a function that is called to save each block of data that the save routine generates. <span class="annotation">[<acronym title="The callback is valid only during the call to the method."><span class="acronym">scope call</span></acronym>]</span>
 
175
</td>
 
176
</tr>
 
177
<tr>
 
178
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 
179
<td>user data to pass to the save function.</td>
 
180
</tr>
 
181
<tr>
 
182
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
 
183
<td>return location for error, or <code class="literal">NULL</code>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
 
184
</td>
 
185
</tr>
 
186
<tr>
 
187
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
188
<td>
 
189
<code class="literal">TRUE</code>, if the save successfully completed</td>
 
190
</tr>
 
191
</tbody>
 
192
</table></div>
 
193
</div>
 
194
</div>
 
195
</div>
 
196
<div class="footer">
 
197
<hr>
 
198
          Generated by GTK-Doc V1.17</div>
 
199
</body>
 
200
</html>
 
 
b'\\ No newline at end of file'