diff options
Diffstat (limited to 'docs/reference/html/SoupCookieJarDB.html')
-rw-r--r-- | docs/reference/html/SoupCookieJarDB.html | 196 |
1 files changed, 196 insertions, 0 deletions
diff --git a/docs/reference/html/SoupCookieJarDB.html b/docs/reference/html/SoupCookieJarDB.html new file mode 100644 index 00000000..f0edeed7 --- /dev/null +++ b/docs/reference/html/SoupCookieJarDB.html @@ -0,0 +1,196 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>libsoup Reference Manual: SoupCookieJarDB</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> +<link rel="home" href="index.html" title="libsoup Reference Manual"> +<link rel="up" href="ch03.html" title="Additional Features"> +<link rel="prev" href="SoupCookieJarText.html" title="SoupCookieJarText"> +<link rel="next" href="SoupLogger.html" title="SoupLogger"> +<meta name="generator" content="GTK-Doc V1.20 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="10"><tr valign="middle"> +<td width="100%" align="left" class="shortcuts"> +<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> + <a href="#SoupCookieJarDB.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> + <a href="#SoupCookieJarDB.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span> + <a href="#SoupCookieJarDB.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span> + <a href="#SoupCookieJarDB.properties" class="shortcut">Properties</a></span> +</td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> +<td><a accesskey="u" href="ch03.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="SoupCookieJarText.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="SoupLogger.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="SoupCookieJarDB"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="SoupCookieJarDB.top_of_page"></a>SoupCookieJarDB</span></h2> +<p>SoupCookieJarDB — Database-based Cookie Jar</p> +</td> +<td class="gallery_image" valign="top" align="right"></td> +</tr></table></div> +<div class="refsect1"> +<a name="SoupCookieJarDB.functions"></a><h2>Functions</h2> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="functions_return"> +<col class="functions_name"> +</colgroup> +<tbody><tr> +<td class="function_type"> +<a class="link" href="SoupCookieJar.html" title="SoupCookieJar"><span class="returnvalue">SoupCookieJar</span></a> * +</td> +<td class="function_name"> +<a class="link" href="SoupCookieJarDB.html#soup-cookie-jar-db-new" title="soup_cookie_jar_db_new ()">soup_cookie_jar_db_new</a> <span class="c_punctuation">()</span> +</td> +</tr></tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="SoupCookieJarDB.properties"></a><h2>Properties</h2> +<div class="informaltable"><table border="0"> +<colgroup> +<col width="150px" class="properties_type"> +<col width="300px" class="properties_name"> +<col width="200px" class="properties_flags"> +</colgroup> +<tbody><tr> +<td class="property_type"> +<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td> +<td class="property_name"><a class="link" href="SoupCookieJarDB.html#SoupCookieJarDB--filename" title="The “filename” property">filename</a></td> +<td class="property_flags">Read / Write / Construct Only</td> +</tr></tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="SoupCookieJarDB.other"></a><h2>Types and Values</h2> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="name"> +<col class="description"> +</colgroup> +<tbody> +<tr> +<td class="datatype_keyword"> </td> +<td class="function_name"><a class="link" href="SoupCookieJarDB.html#SoupCookieJarDB-struct" title="SoupCookieJarDB">SoupCookieJarDB</a></td> +</tr> +<tr> +<td class="define_keyword">#define</td> +<td class="function_name"><a class="link" href="SoupCookieJarDB.html#SOUP-COOKIE-JAR-DB-FILENAME:CAPS" title="SOUP_COOKIE_JAR_DB_FILENAME">SOUP_COOKIE_JAR_DB_FILENAME</a></td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="SoupCookieJarDB.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="screen"> <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a> + <span class="lineart">╰──</span> <a class="link" href="SoupCookieJar.html" title="SoupCookieJar">SoupCookieJar</a> + <span class="lineart">╰──</span> SoupCookieJarDB +</pre> +</div> +<div class="refsect1"> +<a name="SoupCookieJarDB.implemented-interfaces"></a><h2>Implemented Interfaces</h2> +<p> +SoupCookieJarDB implements + <a class="link" href="SoupSessionFeature.html" title="SoupSessionFeature">SoupSessionFeature</a>.</p> +</div> +<div class="refsect1"> +<a name="SoupCookieJarDB.includes"></a><h2>Includes</h2> +<pre class="synopsis">#include <libsoup/soup.h> +</pre> +</div> +<div class="refsect1"> +<a name="SoupCookieJarDB.description"></a><h2>Description</h2> +<p><a class="link" href="SoupCookieJarDB.html" title="SoupCookieJarDB"><span class="type">SoupCookieJarDB</span></a> is a <a class="link" href="SoupCookieJar.html" title="SoupCookieJar"><span class="type">SoupCookieJar</span></a> that reads cookies from and +writes them to a sqlite database in the new Mozilla format.</p> +<p>(This is identical to <code class="literal">SoupCookieJarSqlite</code> in +libsoup-gnome; it has just been moved into libsoup proper, and +renamed to avoid conflicting.)</p> +</div> +<div class="refsect1"> +<a name="SoupCookieJarDB.functions_details"></a><h2>Functions</h2> +<div class="refsect2"> +<a name="soup-cookie-jar-db-new"></a><h3>soup_cookie_jar_db_new ()</h3> +<pre class="programlisting"><a class="link" href="SoupCookieJar.html" title="SoupCookieJar"><span class="returnvalue">SoupCookieJar</span></a> * +soup_cookie_jar_db_new (<em class="parameter"><code>const <span class="type">char</span> *filename</code></em>, + <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> read_only</code></em>);</pre> +<p>Creates a <a class="link" href="SoupCookieJarDB.html" title="SoupCookieJarDB"><span class="type">SoupCookieJarDB</span></a>.</p> +<p><em class="parameter"><code>filename</code></em> + will be read in at startup to create an initial set of +cookies. If <em class="parameter"><code>read_only</code></em> + is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>, then the non-session cookies will +be written to <em class="parameter"><code>filename</code></em> + when the 'changed' signal is emitted from +the jar. (If <em class="parameter"><code>read_only</code></em> + is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, then the cookie jar will only be +used for this session, and changes made to it will be lost when the +jar is destroyed.)</p> +<div class="refsect3"> +<a name="id-1.4.8.10.2.6"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>filename</p></td> +<td class="parameter_description"><p>the filename to read to/write from, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>read_only</p></td> +<td class="parameter_description"><p><a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>filename</code></em> +is read-only</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.4.8.10.2.7"></a><h4>Returns</h4> +<p> the new <a class="link" href="SoupCookieJar.html" title="SoupCookieJar"><span class="type">SoupCookieJar</span></a></p> +<p></p> +</div> +<p class="since">Since 2.42</p> +</div> +</div> +<div class="refsect1"> +<a name="SoupCookieJarDB.other_details"></a><h2>Types and Values</h2> +<div class="refsect2"> +<a name="SoupCookieJarDB-struct"></a><h3>SoupCookieJarDB</h3> +<pre class="programlisting">typedef struct _SoupCookieJarDB SoupCookieJarDB;</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2"> +<a name="SOUP-COOKIE-JAR-DB-FILENAME:CAPS"></a><h3>SOUP_COOKIE_JAR_DB_FILENAME</h3> +<pre class="programlisting">#define SOUP_COOKIE_JAR_DB_FILENAME "filename" +</pre> +<p>Alias for the <a class="link" href="SoupCookieJarDB.html#SoupCookieJarDB--filename" title="The “filename” property"><span class="type">“filename”</span></a> property. (The +cookie-storage filename.)</p> +</div> +</div> +<div class="refsect1"> +<a name="SoupCookieJarDB.property-details"></a><h2>Property Details</h2> +<div class="refsect2"> +<a name="SoupCookieJarDB--filename"></a><h3>The <code class="literal">“filename”</code> property</h3> +<pre class="programlisting"> “filename” <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre> +<p>Cookie-storage filename.</p> +<p>Flags: Read / Write / Construct Only</p> +<p>Default value: NULL</p> +</div> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.20</div> +</body> +</html>
\ No newline at end of file |