Files
clapper/doc/clapper/method.EnhancerProxy.extra_data_lists_value.html
github-actions[bot] 7cc6ca9757 doc: Update
2025-08-11 16:28:59 +00:00

293 lines
9.0 KiB
HTML

<!--
SPDX-FileCopyrightText: Rafał Dzięgiel
SPDX-License-Identifier: LGPL-2.1-or-later
-->
<!DOCTYPE html>
<html lang="en">
<head>
<title>Clapper.EnhancerProxy.extra_data_lists_value</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta charset="utf-8" />
<meta property="og:type" content="website"/>
<meta property="og:image:width" content="256"/>
<meta property="og:image:height" content="256"/>
<meta property="og:image:secure_url" content="clapper-logo.svg"/>
<meta property="og:image:alt" content="Clapper-0.0"/>
<meta priority="og:title" content="Clapper.EnhancerProxy.extra_data_lists_value"/>
<meta priority="og:description" content="Reference for Clapper.EnhancerProxy.extra_data_lists_value"/>
<meta name="twitter:title" content="Clapper.EnhancerProxy.extra_data_lists_value"/>
<meta name="twitter:description" content="Reference for Clapper.EnhancerProxy.extra_data_lists_value"/>
<meta name="twitter:card" content="summary"/>
<link rel="search" type="application/opensearchdescription+xml" title="Clapper" href="opensearch.xml">
<link rel="stylesheet" href="style.css" type="text/css" />
<script src="urlmap.js"></script>
<script src="fzy.js"></script>
<script src="search.js"></script>
<script src="main.js"></script>
</head>
<body>
<div id="body-wrapper" tabindex="-1">
<nav class="sidebar devhelp-hidden">
<div class="section">
<a href="index.html"><img src="clapper-logo.svg" class="logo"/></a>
</div>
<div class="search section">
<form id="search-form" autocomplete="off">
<input id="search-input" type="text" name="do-not-autocomplete" placeholder="Click, or press 's' to search" autocomplete="off"/>
</form>
</div>
<div class="section namespace">
<h3><a href="index.html">Clapper</a></h3>
<p>API Version: 0.0</p>
<p>Library Version: 0.9.1</p>
</div>
<div class="section">
<h5>Type</h5>
<div class="links">
<a href="class.EnhancerProxy.html">EnhancerProxy</a>
</div>
</div>
<div class="section">
<h5>Methods</h5>
<div class="links">
<a class="method current" href="method.EnhancerProxy.extra_data_lists_value.html">extra_data_lists_value</a>
<a class="method" href="method.EnhancerProxy.get_description.html">get_description</a>
<a class="method" href="method.EnhancerProxy.get_extra_data.html">get_extra_data</a>
<a class="method" href="method.EnhancerProxy.get_friendly_name.html">get_friendly_name</a>
<a class="method" href="method.EnhancerProxy.get_module_dir.html">get_module_dir</a>
<a class="method" href="method.EnhancerProxy.get_module_name.html">get_module_name</a>
<a class="method" href="method.EnhancerProxy.get_settings.html">get_settings</a>
<a class="method" href="method.EnhancerProxy.get_target_creation_allowed.html">get_target_creation_allowed</a>
<a class="method" href="method.EnhancerProxy.get_target_interfaces.html">get_target_interfaces</a>
<a class="method" href="method.EnhancerProxy.get_target_properties.html">get_target_properties</a>
<a class="method" href="method.EnhancerProxy.get_version.html">get_version</a>
<a class="method" href="method.EnhancerProxy.set_locally.html">set_locally</a>
<a class="method" href="method.EnhancerProxy.set_locally_with_table.html">set_locally_with_table</a>
<a class="method" href="method.EnhancerProxy.set_target_creation_allowed.html">set_target_creation_allowed</a>
<a class="method" href="method.EnhancerProxy.target_has_interface.html">target_has_interface</a>
</div>
</div>
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2025.4</p>
</div>
</nav>
<button id="btn-to-top" class="hidden"><span class="up-arrow"></span></button>
<section id="main" class="content">
<header>
<h3>Method</h3>
<h1><a href="index.html">Clapper</a><span class="sep"></span><a href="class.EnhancerProxy.html">EnhancerProxy</a><span class="sep"></span>extra_data_lists_value</h1>
</header>
<section>
<div class="docblock">
<p><span class="emblem available-next" title="This method will be available in the next stable release">unstable</span>&nbsp;<span class="emblem available">since: 0.10</span></p>
</div>
<div class="declaration toggle-wrapper">
<h4 style="display:flex;" id="declaration">
Declaration
<a class="anchor" href="#declaration"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/src/lib/clapper/clapper-enhancer-proxy.h#L59">[src]</a>
</h4>
<div class="docblock c-decl">
<pre><code><div class="highlight"><pre><span></span><span class="n">gboolean</span>
<span class="n">clapper_enhancer_proxy_extra_data_lists_value</span><span class="w"> </span><span class="p">(</span>
<span class="w"> </span><span class="n">ClapperEnhancerProxy</span><span class="o">*</span><span class="w"> </span><span class="n">proxy</span><span class="p">,</span>
<span class="w"> </span><span class="k">const</span><span class="w"> </span><span class="n">gchar</span><span class="o">*</span><span class="w"> </span><span class="n">key</span><span class="p">,</span>
<span class="w"> </span><span class="k">const</span><span class="w"> </span><span class="n">gchar</span><span class="o">*</span><span class="w"> </span><span class="n">value</span>
<span class="p">)</span>
</pre></div>
</code></pre>
</div>
</div>
<div class="description toggle-wrapper">
<h4 style="display:flex;" id="description">
Description
<a class="anchor" href="#description"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/src/lib/clapper/clapper-enhancer-proxy.c#L727">[src]</a>
</h4>
<div class="docblock">
<p>A convenience function to check whether <code>proxy</code> plugin file
has an extra data field with <code>key</code> that among separated list
of values includes <code>value</code> (works on single value lists&nbsp;too).</p>
<p>For example, when extra data in the plugin is <code>X-Schemes=https;http</code>,
calling this function with &#8220;X-Schemes&#8221; as key and &#8220;http&#8221; as value will
return <code>TRUE</code>.</p>
<p>It is also safe to call this function when there is no such <code>key</code>
in plugin info file. Use <a href="method.EnhancerProxy.get_extra_data.html"><code>clapper_enhancer_proxy_get_extra_data()</code></a>
if you need to know whether key&nbsp;exists.</p>
</div>
<div class="docblock">
<p>Available since: 0.10</p>
</div>
</div>
<div class="parameters toggle-wrapper">
<h4 id="parameters">
Parameters
<a href="#parameters" class="anchor"></a>
</h4>
<div class="docblock">
<dl class="arguments">
<dt class="arg-name"><code>key</code></dt>
<dd class="arg-description">
<p><em>Type:</em>&nbsp;<code>const gchar*</code></p>
<p>Name of the data to&nbsp;lookup.</p>
<table>
<tr><td title="transfer: none">The data is owned by the caller of the method.</td></tr>
<tr><td>The value is a NUL terminated UTF-8 string.</td></tr>
</table>
</dd>
<dt class="arg-name"><code>value</code></dt>
<dd class="arg-description">
<p><em>Type:</em>&nbsp;<code>const gchar*</code></p>
<p>String to check&nbsp;for.</p>
<table>
<tr><td title="transfer: none">The data is owned by the caller of the method.</td></tr>
<tr><td>The value is a NUL terminated UTF-8 string.</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<div class="return-value toggle-wrapper">
<h4 id="return-value">
Return value
<a href="#return-value" class="anchor"></a>
</h4>
<div class="docblock">
<div class="returns">
<div class="arg-description">
<p><em>Type:</em>&nbsp;<code>gboolean</code></p>
<p>Whether list named with <code>key</code> existed and contained <code>value</code>.</p>
</div>
<div>
<table>
</table>
</div>
</div>
</div>
</div>
</section>
</section>
<section id="search" class="content hidden"></section>
<footer>
</footer>
</div>
</body>
</html>