diff options
Diffstat (limited to 'docs/libnm/html/NMSettingMatch.html')
| -rw-r--r-- | docs/libnm/html/NMSettingMatch.html | 383 |
1 files changed, 383 insertions, 0 deletions
diff --git a/docs/libnm/html/NMSettingMatch.html b/docs/libnm/html/NMSettingMatch.html new file mode 100644 index 00000000..fd15e721 --- /dev/null +++ b/docs/libnm/html/NMSettingMatch.html @@ -0,0 +1,383 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>NMSettingMatch: libnm Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"> +<link rel="home" href="index.html" title="libnm Reference Manual"> +<link rel="up" href="ch03.html" title="Connection and Setting API Reference"> +<link rel="prev" href="NMSettingMacvlan.html" title="NMSettingMacvlan"> +<link rel="next" href="NMSettingOlpcMesh.html" title="NMSettingOlpcMesh"> +<meta name="generator" content="GTK-Doc V1.29.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="#NMSettingMatch.description" class="shortcut">Description</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="NMSettingMacvlan.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="NMSettingOlpcMesh.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="NMSettingMatch"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="NMSettingMatch.top_of_page"></a>NMSettingMatch</span></h2> +<p>NMSettingMatch — Properties to match a connection with a device.</p> +</td> +<td class="gallery_image" valign="top" align="right"></td> +</tr></table></div> +<div class="refsect1"> +<a name="NMSettingMatch.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="NMSetting.html" title="NMSetting"><span class="returnvalue">NMSetting</span></a> * +</td> +<td class="function_name"> +<a class="link" href="NMSettingMatch.html#nm-setting-match-new" title="nm_setting_match_new ()">nm_setting_match_new</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> +</td> +<td class="function_name"> +<a class="link" href="NMSettingMatch.html#nm-setting-match-get-num-interface-names" title="nm_setting_match_get_num_interface_names ()">nm_setting_match_get_num_interface_names</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type">const <span class="returnvalue">char</span> * +</td> +<td class="function_name"> +<a class="link" href="NMSettingMatch.html#nm-setting-match-get-interface-name" title="nm_setting_match_get_interface_name ()">nm_setting_match_get_interface_name</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">void</span> +</td> +<td class="function_name"> +<a class="link" href="NMSettingMatch.html#nm-setting-match-remove-interface-name" title="nm_setting_match_remove_interface_name ()">nm_setting_match_remove_interface_name</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +</td> +<td class="function_name"> +<a class="link" href="NMSettingMatch.html#nm-setting-match-remove-interface-name-by-value" title="nm_setting_match_remove_interface_name_by_value ()">nm_setting_match_remove_interface_name_by_value</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">void</span> +</td> +<td class="function_name"> +<a class="link" href="NMSettingMatch.html#nm-setting-match-add-interface-name" title="nm_setting_match_add_interface_name ()">nm_setting_match_add_interface_name</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">void</span> +</td> +<td class="function_name"> +<a class="link" href="NMSettingMatch.html#nm-setting-match-clear-interface-names" title="nm_setting_match_clear_interface_names ()">nm_setting_match_clear_interface_names</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type">const <span class="returnvalue">char</span> *const * +</td> +<td class="function_name"> +<a class="link" href="NMSettingMatch.html#nm-setting-match-get-interface-names" title="nm_setting_match_get_interface_names ()">nm_setting_match_get_interface_names</a> <span class="c_punctuation">()</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="NMSettingMatch.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="define_keyword">#define</td> +<td class="function_name"><a class="link" href="NMSettingMatch.html#NM-SETTING-MATCH-SETTING-NAME:CAPS" title="NM_SETTING_MATCH_SETTING_NAME">NM_SETTING_MATCH_SETTING_NAME</a></td> +</tr> +<tr> +<td class="define_keyword">#define</td> +<td class="function_name"><a class="link" href="NMSettingMatch.html#NM-SETTING-MATCH-INTERFACE-NAME:CAPS" title="NM_SETTING_MATCH_INTERFACE_NAME">NM_SETTING_MATCH_INTERFACE_NAME</a></td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="NMSettingMatch.includes"></a><h2>Includes</h2> +<pre class="synopsis">#include <nm-setting-match.h> +</pre> +</div> +<div class="refsect1"> +<a name="NMSettingMatch.description"></a><h2>Description</h2> +</div> +<div class="refsect1"> +<a name="NMSettingMatch.functions_details"></a><h2>Functions</h2> +<div class="refsect2"> +<a name="nm-setting-match-new"></a><h3>nm_setting_match_new ()</h3> +<pre class="programlisting"><a class="link" href="NMSetting.html" title="NMSetting"><span class="returnvalue">NMSetting</span></a> * +nm_setting_match_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> +<p>Creates a new <a class="link" href="NMSettingMatch.html" title="NMSettingMatch"><span class="type">NMSettingMatch</span></a> object with default values.</p> +<div class="refsect3"> +<a name="nm-setting-match-new.returns"></a><h4>Returns</h4> +<p>the new empty <a class="link" href="NMSettingMatch.html" title="NMSettingMatch"><span class="type">NMSettingMatch</span></a> object. </p> +<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> +</div> +<p class="since">Since: 1.14</p> +</div> +<hr> +<div class="refsect2"> +<a name="nm-setting-match-get-num-interface-names"></a><h3>nm_setting_match_get_num_interface_names ()</h3> +<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> +nm_setting_match_get_num_interface_names + (<em class="parameter"><code><a class="link" href="NMSettingMatch.html" title="NMSettingMatch"><span class="type">NMSettingMatch</span></a> *setting</code></em>);</pre> +<div class="refsect3"> +<a name="nm-setting-match-get-num-interface-names.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>setting</p></td> +<td class="parameter_description"><p>the <a class="link" href="NMSettingMatch.html" title="NMSettingMatch"><span class="type">NMSettingMatch</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="nm-setting-match-get-num-interface-names.returns"></a><h4>Returns</h4> +<p> the number of configured interface names</p> +</div> +<p class="since">Since: 1.14</p> +</div> +<hr> +<div class="refsect2"> +<a name="nm-setting-match-get-interface-name"></a><h3>nm_setting_match_get_interface_name ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * +nm_setting_match_get_interface_name (<em class="parameter"><code><a class="link" href="NMSettingMatch.html" title="NMSettingMatch"><span class="type">NMSettingMatch</span></a> *setting</code></em>, + <em class="parameter"><code><span class="type">int</span> idx</code></em>);</pre> +<div class="refsect3"> +<a name="nm-setting-match-get-interface-name.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>setting</p></td> +<td class="parameter_description"><p>the <a class="link" href="NMSettingMatch.html" title="NMSettingMatch"><span class="type">NMSettingMatch</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>idx</p></td> +<td class="parameter_description"><p>index number of the DNS search domain to return</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="nm-setting-match-get-interface-name.returns"></a><h4>Returns</h4> +<p> the interface name at index <em class="parameter"><code>idx</code></em> +</p> +</div> +<p class="since">Since: 1.14</p> +</div> +<hr> +<div class="refsect2"> +<a name="nm-setting-match-remove-interface-name"></a><h3>nm_setting_match_remove_interface_name ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +nm_setting_match_remove_interface_name + (<em class="parameter"><code><a class="link" href="NMSettingMatch.html" title="NMSettingMatch"><span class="type">NMSettingMatch</span></a> *setting</code></em>, + <em class="parameter"><code><span class="type">int</span> idx</code></em>);</pre> +<p>Removes the interface name at index <em class="parameter"><code>idx</code></em> +.</p> +<div class="refsect3"> +<a name="nm-setting-match-remove-interface-name.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>setting</p></td> +<td class="parameter_description"><p>the <a class="link" href="NMSettingMatch.html" title="NMSettingMatch"><span class="type">NMSettingMatch</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>idx</p></td> +<td class="parameter_description"><p>index number of the interface name</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<p class="since">Since: 1.14</p> +</div> +<hr> +<div class="refsect2"> +<a name="nm-setting-match-remove-interface-name-by-value"></a><h3>nm_setting_match_remove_interface_name_by_value ()</h3> +<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +nm_setting_match_remove_interface_name_by_value + (<em class="parameter"><code><a class="link" href="NMSettingMatch.html" title="NMSettingMatch"><span class="type">NMSettingMatch</span></a> *setting</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *interface_name</code></em>);</pre> +<p>Removes <em class="parameter"><code>interface_name</code></em> +.</p> +<div class="refsect3"> +<a name="nm-setting-match-remove-interface-name-by-value.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>setting</p></td> +<td class="parameter_description"><p>the <a class="link" href="NMSettingMatch.html" title="NMSettingMatch"><span class="type">NMSettingMatch</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>interface_name</p></td> +<td class="parameter_description"><p>the interface name to remove</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="nm-setting-match-remove-interface-name-by-value.returns"></a><h4>Returns</h4> +<p> <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the interface name was found and removed; <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if it was not.</p> +</div> +<p class="since">Since: 1.14</p> +</div> +<hr> +<div class="refsect2"> +<a name="nm-setting-match-add-interface-name"></a><h3>nm_setting_match_add_interface_name ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +nm_setting_match_add_interface_name (<em class="parameter"><code><a class="link" href="NMSettingMatch.html" title="NMSettingMatch"><span class="type">NMSettingMatch</span></a> *setting</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *interface_name</code></em>);</pre> +<p>Adds a new interface name to the setting.</p> +<div class="refsect3"> +<a name="nm-setting-match-add-interface-name.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>setting</p></td> +<td class="parameter_description"><p>the <a class="link" href="NMSettingMatch.html" title="NMSettingMatch"><span class="type">NMSettingMatch</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>interface_name</p></td> +<td class="parameter_description"><p>the interface name to add</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<p class="since">Since: 1.14</p> +</div> +<hr> +<div class="refsect2"> +<a name="nm-setting-match-clear-interface-names"></a><h3>nm_setting_match_clear_interface_names ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +nm_setting_match_clear_interface_names + (<em class="parameter"><code><a class="link" href="NMSettingMatch.html" title="NMSettingMatch"><span class="type">NMSettingMatch</span></a> *setting</code></em>);</pre> +<p>Removes all configured interface names.</p> +<div class="refsect3"> +<a name="nm-setting-match-clear-interface-names.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>setting</p></td> +<td class="parameter_description"><p>the <a class="link" href="NMSettingMatch.html" title="NMSettingMatch"><span class="type">NMSettingMatch</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<p class="since">Since: 1.14</p> +</div> +<hr> +<div class="refsect2"> +<a name="nm-setting-match-get-interface-names"></a><h3>nm_setting_match_get_interface_names ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> *const * +nm_setting_match_get_interface_names (<em class="parameter"><code><a class="link" href="NMSettingMatch.html" title="NMSettingMatch"><span class="type">NMSettingMatch</span></a> *setting</code></em>, + <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> *length</code></em>);</pre> +<p>Returns all the interface names.</p> +<div class="refsect3"> +<a name="nm-setting-match-get-interface-names.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>setting</p></td> +<td class="parameter_description"><p>the <a class="link" href="NMSettingMatch.html" title="NMSettingMatch"><span class="type">NMSettingMatch</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="nm-setting-match-get-interface-names.returns"></a><h4>Returns</h4> +<p>the configured interface names. </p> +<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p> +</div> +<p class="since">Since: 1.14</p> +</div> +</div> +<div class="refsect1"> +<a name="NMSettingMatch.other_details"></a><h2>Types and Values</h2> +<div class="refsect2"> +<a name="NM-SETTING-MATCH-SETTING-NAME:CAPS"></a><h3>NM_SETTING_MATCH_SETTING_NAME</h3> +<pre class="programlisting">#define NM_SETTING_MATCH_SETTING_NAME "match" +</pre> +</div> +<hr> +<div class="refsect2"> +<a name="NM-SETTING-MATCH-INTERFACE-NAME:CAPS"></a><h3>NM_SETTING_MATCH_INTERFACE_NAME</h3> +<pre class="programlisting">#define NM_SETTING_MATCH_INTERFACE_NAME "interface-name" +</pre> +</div> +</div> +</div> +<div class="footer"> +<hr>Generated by GTK-Doc V1.29.1</div> +</body> +</html> \ No newline at end of file |