← Back to branch summary

~ubuntu-branches/ubuntu/jaunty/libsoup2.4/jaunty-proposed

« back to all changes in this revision

Viewing changes to docs/reference/html/SoupCookieJarText.html

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2008-12-17 14:51:11 UTC
  • mfrom: (1.1.12 upstream)
  • Revision ID: james.westby@ubuntu.com-20081217145111-sqbz10l57fmrh4vz
Tags: 2.25.4-0ubuntu1
* New upstream version
* debian/control.in:
  - build-depends on libgconf2-dev, libproxy-dev
* Updated to list the new libsoup-gnome binaries
* debian/rules:
  - updated shlibs version and list the new library

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/html/SoupCookieJarText.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>SoupCookieJarText</title>
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.74.0">
 
7
<link rel="home" href="index.html" title="libsoup Reference Manual">
 
8
<link rel="up" href="ch02.html" title="Core API">
 
9
<link rel="prev" href="SoupCookieJar.html" title="SoupCookieJar">
 
10
<link rel="next" href="SoupLogger.html" title="SoupLogger">
 
11
<meta name="generator" content="GTK-Doc V1.11 (XML mode)">
 
12
<link rel="stylesheet" href="style.css" type="text/css">
 
13
<link rel="chapter" href="ch01.html" title="Tutorial">
 
14
<link rel="chapter" href="ch02.html" title="Core API">
 
15
<link rel="chapter" href="ch03.html" title="Web Services APIs">
 
16
<link rel="chapter" href="ch04.html" title="GNOME integration">
 
17
<link rel="chapter" href="ch05.html" title="Low-level Networking API">
 
18
<link rel="index" href="ix01.html" title="Index">
 
19
</head>
 
20
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
 
21
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
 
22
<tr valign="middle">
 
23
<td><a accesskey="p" href="SoupCookieJar.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
 
24
<td><a accesskey="u" href="ch02.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
 
25
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
 
26
<th width="100%" align="center">libsoup Reference Manual</th>
 
27
<td><a accesskey="n" href="SoupLogger.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
 
28
</tr>
 
29
<tr><td colspan="5" class="shortcuts">
 
30
<a href="#SoupCookieJarText.synopsis" class="shortcut">Top</a>
 
31
                 | 
 
32
                <a href="#SoupCookieJarText.description" class="shortcut">Description</a>
 
33
                 | 
 
34
                <a href="#SoupCookieJarText.object-hierarchy" class="shortcut">Object Hierarchy</a>
 
35
                 | 
 
36
                <a href="#SoupCookieJarText.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
 
37
                 | 
 
38
                <a href="#SoupCookieJarText.properties" class="shortcut">Properties</a>
 
39
</td></tr>
 
40
</table>
 
41
<div class="refentry" lang="en">
 
42
<a name="SoupCookieJarText"></a><div class="titlepage"></div>
 
43
<div class="refnamediv"><table width="100%"><tr>
 
44
<td valign="top">
 
45
<h2><span class="refentrytitle"><a name="SoupCookieJarText.top_of_page"></a>SoupCookieJarText</span></h2>
 
46
<p>SoupCookieJarText — Text-file-based ("cookies.txt") Cookie Jar</p>
 
47
</td>
 
48
<td valign="top" align="right"></td>
 
49
</tr></table></div>
 
50
<div class="refsynopsisdiv">
 
51
<a name="SoupCookieJarText.synopsis"></a><h2>Synopsis</h2>
 
52
<pre class="synopsis">
 
53
                    <a class="link" href="SoupCookieJarText.html#SoupCookieJarText-struct" title="SoupCookieJarText">SoupCookieJarText</a>;
 
54
<a class="link" href="SoupCookieJar.html" title="SoupCookieJar">SoupCookieJar</a> *     <a class="link" href="SoupCookieJarText.html#soup-cookie-jar-text-new" title="soup_cookie_jar_text_new ()">soup_cookie_jar_text_new</a>            (const char *filename,
 
55
                                                         <a
 
56
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
 
57
>gboolean</a> read_only);
 
58
 
 
59
#define             <a class="link" href="SoupCookieJarText.html#SOUP-COOKIE-JAR-TEXT-FILENAME--CAPS" title="SOUP_COOKIE_JAR_TEXT_FILENAME">SOUP_COOKIE_JAR_TEXT_FILENAME</a>
 
60
</pre>
 
61
</div>
 
62
<div class="refsect1" lang="en">
 
63
<a name="SoupCookieJarText.object-hierarchy"></a><h2>Object Hierarchy</h2>
 
64
<pre class="synopsis">
 
65
  <a
 
66
href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject"
 
67
>GObject</a>
 
68
   +----<a class="link" href="SoupCookieJar.html" title="SoupCookieJar">SoupCookieJar</a>
 
69
         +----SoupCookieJarText
 
70
</pre>
 
71
</div>
 
72
<div class="refsect1" lang="en">
 
73
<a name="SoupCookieJarText.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
 
74
<p>
 
75
SoupCookieJarText implements
 
76
 <a class="link" href="SoupSession.html#SoupSessionFeature">SoupSessionFeature</a>.</p>
 
77
</div>
 
78
<div class="refsect1" lang="en">
 
79
<a name="SoupCookieJarText.properties"></a><h2>Properties</h2>
 
80
<pre class="synopsis">
 
81
  "<a class="link" href="SoupCookieJarText.html#SoupCookieJarText--filename" title='The "filename" property'>filename</a>"                 <a
 
82
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
 
83
>gchar</a>*                : Read / Write / Construct Only
 
84
</pre>
 
85
</div>
 
86
<div class="refsect1" lang="en">
 
87
<a name="SoupCookieJarText.description"></a><h2>Description</h2>
 
88
<p>
 
89
<a class="link" href="SoupCookieJarText.html" title="SoupCookieJarText"><span class="type">SoupCookieJarText</span></a> is a <a class="link" href="SoupCookieJar.html" title="SoupCookieJar"><span class="type">SoupCookieJar</span></a> that reads cookies from and
 
90
writes them to a text file in the Mozilla "cookies.txt" format.</p>
 
91
<p>
 
92
</p>
 
93
</div>
 
94
<div class="refsect1" lang="en">
 
95
<a name="SoupCookieJarText.details"></a><h2>Details</h2>
 
96
<div class="refsect2" lang="en">
 
97
<a name="SoupCookieJarText-struct"></a><h3>SoupCookieJarText</h3>
 
98
<pre class="programlisting">typedef struct _SoupCookieJarText SoupCookieJarText;</pre>
 
99
<p>
 
100
</p>
 
101
</div>
 
102
<hr>
 
103
<div class="refsect2" lang="en">
 
104
<a name="soup-cookie-jar-text-new"></a><h3>soup_cookie_jar_text_new ()</h3>
 
105
<pre class="programlisting"><a class="link" href="SoupCookieJar.html" title="SoupCookieJar">SoupCookieJar</a> *     soup_cookie_jar_text_new            (const char *filename,
 
106
                                                         <a
 
107
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
 
108
>gboolean</a> read_only);</pre>
 
109
<p>
 
110
Creates a <a class="link" href="SoupCookieJarText.html" title="SoupCookieJarText"><span class="type">SoupCookieJarText</span></a>.
 
111
</p>
 
112
<p>
 
113
<em class="parameter"><code>filename</code></em> will be read in at startup to create an initial set of
 
114
cookies. If <em class="parameter"><code>read_only</code></em> is <a
 
115
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE--CAPS"
 
116
><code class="literal">FALSE</code></a>, then the non-session cookies will
 
117
be written to <em class="parameter"><code>filename</code></em> when the 'changed' signal is emitted from
 
118
the jar. (If <em class="parameter"><code>read_only</code></em> is <a
 
119
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE--CAPS"
 
120
><code class="literal">TRUE</code></a>, then the cookie jar will only be
 
121
used for this session, and changes made to it will be lost when the
 
122
jar is destroyed.)</p>
 
123
<p>
 
124
</p>
 
125
<div class="variablelist"><table border="0">
 
126
<col align="left" valign="top">
 
127
<tbody>
 
128
<tr>
 
129
<td><p><span class="term"><em class="parameter"><code>filename</code></em> :</span></p></td>
 
130
<td> the filename to read to/write from
 
131
</td>
 
132
</tr>
 
133
<tr>
 
134
<td><p><span class="term"><em class="parameter"><code>read_only</code></em> :</span></p></td>
 
135
<td> <a
 
136
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE--CAPS"
 
137
><code class="literal">TRUE</code></a> if <em class="parameter"><code>filename</code></em> is read-only
 
138
</td>
 
139
</tr>
 
140
<tr>
 
141
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
142
<td> the new <a class="link" href="SoupCookieJar.html" title="SoupCookieJar"><span class="type">SoupCookieJar</span></a>
 
143
</td>
 
144
</tr>
 
145
</tbody>
 
146
</table></div>
 
147
</div>
 
148
<hr>
 
149
<div class="refsect2" lang="en">
 
150
<a name="SOUP-COOKIE-JAR-TEXT-FILENAME--CAPS"></a><h3>SOUP_COOKIE_JAR_TEXT_FILENAME</h3>
 
151
<pre class="programlisting">#define SOUP_COOKIE_JAR_TEXT_FILENAME  "filename"
 
152
</pre>
 
153
<p>
 
154
</p>
 
155
</div>
 
156
</div>
 
157
<div class="refsect1" lang="en">
 
158
<a name="SoupCookieJarText.property-details"></a><h2>Property Details</h2>
 
159
<div class="refsect2" lang="en">
 
160
<a name="SoupCookieJarText--filename"></a><h3>The <code class="literal">"filename"</code> property</h3>
 
161
<pre class="programlisting">  "filename"                 <a
 
162
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
 
163
>gchar</a>*                : Read / Write / Construct Only</pre>
 
164
<p>Cookie-storage filename.</p>
 
165
<p>Default value: NULL</p>
 
166
</div>
 
167
</div>
 
168
</div>
 
169
<div class="footer">
 
170
<hr>
 
171
          Generated by GTK-Doc V1.11</div>
 
172
</body>
 
173
</html>