source-git / libsoup

Clone
Source Code
GIT

Files

  1.   ca38770256bd1a9efc9df9ccd2142073bdffe766
  2.   docs
  3.   reference
  4.   html
  5.   SoupCookieJarText.html
Blob Blame History Raw 
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>SoupCookieJarText: libsoup Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="libsoup Reference Manual">
<link rel="up" href="ch03.html" title="Additional Features">
<link rel="prev" href="SoupCookieJar.html" title="SoupCookieJar">
<link rel="next" href="SoupCookieJarDB.html" title="SoupCookieJarDB">
<meta name="generator" content="GTK-Doc V1.28.1 (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="5"><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="#SoupCookieJarText.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#SoupCookieJarText.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces">  <span class="dim">|</span> 
                  <a href="#SoupCookieJarText.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties">  <span class="dim">|</span> 
                  <a href="#SoupCookieJarText.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="SoupCookieJar.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="SoupCookieJarDB.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="SoupCookieJarText"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="SoupCookieJarText.top_of_page"></a>SoupCookieJarText</span></h2>
<p>SoupCookieJarText — Text-file-based ("cookies.txt") Cookie Jar</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="SoupCookieJarText.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" 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="SoupCookieJarText.html#soup-cookie-jar-text-new" title="soup_cookie_jar_text_new ()">soup_cookie_jar_text_new</a> <span class="c_punctuation">()</span>
</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="SoupCookieJarText.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" 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">
<span class="type">gchar</span> *</td>
<td class="property_name"><a class="link" href="SoupCookieJarText.html#SoupCookieJarText--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="SoupCookieJarText.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" 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="SoupCookieJarText.html#SoupCookieJarText-struct" title="SoupCookieJarText">SoupCookieJarText</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="SoupCookieJarText.html#SOUP-COOKIE-JAR-TEXT-FILENAME:CAPS" title="SOUP_COOKIE_JAR_TEXT_FILENAME">SOUP_COOKIE_JAR_TEXT_FILENAME</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="SoupCookieJarText.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    GObject
    <span class="lineart">╰──</span> <a class="link" href="SoupCookieJar.html" title="SoupCookieJar">SoupCookieJar</a>
        <span class="lineart">╰──</span> SoupCookieJarText
</pre>
</div>
<div class="refsect1">
<a name="SoupCookieJarText.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
SoupCookieJarText implements
 <a class="link" href="SoupSessionFeature.html" title="SoupSessionFeature">SoupSessionFeature</a>.</p>
</div>
<div class="refsect1">
<a name="SoupCookieJarText.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;libsoup/soup.h&gt;
</pre>
</div>
<div class="refsect1">
<a name="SoupCookieJarText.description"></a><h2>Description</h2>
<p><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
writes them to a text file in the Mozilla "cookies.txt" format.</p>
</div>
<div class="refsect1">
<a name="SoupCookieJarText.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="soup-cookie-jar-text-new"></a><h3>soup_cookie_jar_text_new ()</h3>
<pre class="programlisting"><a class="link" href="SoupCookieJar.html" title="SoupCookieJar"><span class="returnvalue">SoupCookieJar</span></a> *
soup_cookie_jar_text_new (<em class="parameter"><code>const <span class="type">char</span> *filename</code></em>,
                          <em class="parameter"><code><span class="type">gboolean</span> read_only</code></em>);</pre>
<p>Creates a <a class="link" href="SoupCookieJarText.html" title="SoupCookieJarText"><span class="type">SoupCookieJarText</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 <code class="literal">FALSE</code>, 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 <code class="literal">TRUE</code>, 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="soup-cookie-jar-text-new.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>read_only</p></td>
<td class="parameter_description"><p><code class="literal">TRUE</code> 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="soup-cookie-jar-text-new.returns"></a><h4>Returns</h4>
<p> the new <a class="link" href="SoupCookieJar.html" title="SoupCookieJar"><span class="type">SoupCookieJar</span></a></p>
</div>
<p class="since">Since: 2.26</p>
</div>
</div>
<div class="refsect1">
<a name="SoupCookieJarText.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="SoupCookieJarText-struct"></a><h3>SoupCookieJarText</h3>
<pre class="programlisting">typedef struct _SoupCookieJarText SoupCookieJarText;</pre>
</div>
<hr>
<div class="refsect2">
<a name="SOUP-COOKIE-JAR-TEXT-FILENAME:CAPS"></a><h3>SOUP_COOKIE_JAR_TEXT_FILENAME</h3>
<pre class="programlisting">#define SOUP_COOKIE_JAR_TEXT_FILENAME  "filename"
</pre>
<p>Alias for the <a class="link" href="SoupCookieJarText.html#SoupCookieJarText--filename" title="The “filename” property"><span class="type">“filename”</span></a> property. (The
cookie-storage filename.)</p>
</div>
</div>
<div class="refsect1">
<a name="SoupCookieJarText.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="SoupCookieJarText--filename"></a><h3>The <code class="literal">“filename”</code> property</h3>
<pre class="programlisting">  “filename”                 <span class="type">gchar</span> *</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.28.1</div>
</body>
</html>

Powered by Pagure 5.14.1

SSH Hostkey/Fingerprint | Documentation