diff options
| author | Sebastien Bacher <seb128@ubuntu.com> | 2021-01-11 17:41:24 +0100 |
|---|---|---|
| committer | Sebastien Bacher <seb128@ubuntu.com> | 2021-01-11 17:41:24 +0100 |
| commit | a82e048a943092315a32d745c99e0f5635e29134 (patch) | |
| tree | e2daea99a161768c9b956bfea9117289deaf31be /docs/libnm/html/NMSettingIP4Config.html | |
| parent | b51f06ff71a2060925bf3c0f04c44bd12480e670 (diff) | |
| parent | 65f86e8f56267192d42f2b629fc6b0c99fb9cd0c (diff) | |
Merge branch 'upstream/latest' of https://salsa.debian.org/utopia-team/network-manager into upstream/latest
Diffstat (limited to 'docs/libnm/html/NMSettingIP4Config.html')
| -rw-r--r-- | docs/libnm/html/NMSettingIP4Config.html | 93 |
1 files changed, 80 insertions, 13 deletions
diff --git a/docs/libnm/html/NMSettingIP4Config.html b/docs/libnm/html/NMSettingIP4Config.html index 9a2ad209..a8470134 100644 --- a/docs/libnm/html/NMSettingIP4Config.html +++ b/docs/libnm/html/NMSettingIP4Config.html @@ -8,7 +8,7 @@ <link rel="up" href="ch03.html" title="Connection and Setting API Reference"> <link rel="prev" href="NMSettingInfiniband.html" title="NMSettingInfiniband"> <link rel="next" href="NMSettingIP6Config.html" title="NMSettingIP6Config"> -<meta name="generator" content="GTK-Doc V1.32 (XML mode)"> +<meta name="generator" content="GTK-Doc V1.33.1 (XML mode)"> <link rel="stylesheet" href="style.css" type="text/css"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> @@ -63,6 +63,13 @@ <a class="link" href="NMSettingIP4Config.html#nm-setting-ip4-config-get-dhcp-fqdn" title="nm_setting_ip4_config_get_dhcp_fqdn ()">nm_setting_ip4_config_get_dhcp_fqdn</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="NMSettingIP4Config.html#nm-setting-ip4-config-get-dhcp-vendor-class-identifier" title="nm_setting_ip4_config_get_dhcp_vendor_class_identifier ()">nm_setting_ip4_config_get_dhcp_vendor_class_identifier</a> <span class="c_punctuation">()</span> +</td> +</tr> </tbody> </table></div> </div> @@ -77,16 +84,22 @@ <tbody> <tr> <td class="property_type"> -<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td> +<span class="type">char</span> *</td> <td class="property_name"><a class="link" href="NMSettingIP4Config.html#NMSettingIP4Config--dhcp-client-id" title="The “dhcp-client-id” property">dhcp-client-id</a></td> <td class="property_flags">Read / Write</td> </tr> <tr> <td class="property_type"> -<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td> +<span class="type">char</span> *</td> <td class="property_name"><a class="link" href="NMSettingIP4Config.html#NMSettingIP4Config--dhcp-fqdn" title="The “dhcp-fqdn” property">dhcp-fqdn</a></td> <td class="property_flags">Read / Write</td> </tr> +<tr> +<td class="property_type"> +<span class="type">char</span> *</td> +<td class="property_name"><a class="link" href="NMSettingIP4Config.html#NMSettingIP4Config--dhcp-vendor-class-identifier" title="The “dhcp-vendor-class-identifier” property">dhcp-vendor-class-identifier</a></td> +<td class="property_flags">Read / Write</td> +</tr> </tbody> </table></div> </div> @@ -112,6 +125,10 @@ </tr> <tr> <td class="define_keyword">#define</td> +<td class="function_name"><a class="link" href="NMSettingIP4Config.html#NM-SETTING-IP4-CONFIG-DHCP-VENDOR-CLASS-IDENTIFIER:CAPS" title="NM_SETTING_IP4_CONFIG_DHCP_VENDOR_CLASS_IDENTIFIER">NM_SETTING_IP4_CONFIG_DHCP_VENDOR_CLASS_IDENTIFIER</a></td> +</tr> +<tr> +<td class="define_keyword">#define</td> <td class="function_name"><a class="link" href="NMSettingIP4Config.html#NM-SETTING-IP4-CONFIG-METHOD-AUTO:CAPS" title="NM_SETTING_IP4_CONFIG_METHOD_AUTO">NM_SETTING_IP4_CONFIG_METHOD_AUTO</a></td> </tr> <tr> @@ -174,7 +191,7 @@ nm_setting_ip4_config_new (<em class="parameter"><code><span class="type">void</ <div class="refsect3"> <a name="nm-setting-ip4-config-new.returns"></a><h4>Returns</h4> <p>the new empty <a class="link" href="NMSettingIP4Config.html" title="NMSettingIP4Config"><span class="type">NMSettingIP4Config</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> +<p><span class="annotation">[<acronym title="The caller owns the data, and is responsible for free it."><span class="acronym">transfer full</span></acronym>]</span></p> </div> </div> <hr> @@ -234,6 +251,35 @@ property.</p> </div> <p class="since">Since: 1.2</p> </div> +<hr> +<div class="refsect2"> +<a name="nm-setting-ip4-config-get-dhcp-vendor-class-identifier"></a><h3>nm_setting_ip4_config_get_dhcp_vendor_class_identifier ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * +nm_setting_ip4_config_get_dhcp_vendor_class_identifier + (<em class="parameter"><code><a class="link" href="NMSettingIP4Config.html" title="NMSettingIP4Config"><span class="type">NMSettingIP4Config</span></a> *setting</code></em>);</pre> +<p>Returns the value contained in the <a class="link" href="NMSettingIP4Config.html#NMSettingIP4Config--dhcp-vendor-class-identifier" title="The “dhcp-vendor-class-identifier” property"><span class="type">“dhcp_vendor_class_identifier”</span></a> +property.</p> +<div class="refsect3"> +<a name="nm-setting-ip4-config-get-dhcp-vendor-class-identifier.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="NMSettingIP4Config.html" title="NMSettingIP4Config"><span class="type">NMSettingIP4Config</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="nm-setting-ip4-config-get-dhcp-vendor-class-identifier.returns"></a><h4>Returns</h4> +<p> the vendor class identifier option to send to the DHCP server</p> +</div> +<p class="since">Since: 1.28</p> +</div> </div> <div class="refsect1"> <a name="NMSettingIP4Config.other_details"></a><h2>Types and Values</h2> @@ -245,19 +291,25 @@ property.</p> <hr> <div class="refsect2"> <a name="NM-SETTING-IP4-CONFIG-DHCP-CLIENT-ID:CAPS"></a><h3>NM_SETTING_IP4_CONFIG_DHCP_CLIENT_ID</h3> -<pre class="programlisting">#define NM_SETTING_IP4_CONFIG_DHCP_CLIENT_ID "dhcp-client-id" +<pre class="programlisting">#define NM_SETTING_IP4_CONFIG_DHCP_CLIENT_ID "dhcp-client-id" </pre> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-IP4-CONFIG-DHCP-FQDN:CAPS"></a><h3>NM_SETTING_IP4_CONFIG_DHCP_FQDN</h3> -<pre class="programlisting">#define NM_SETTING_IP4_CONFIG_DHCP_FQDN "dhcp-fqdn" +<pre class="programlisting">#define NM_SETTING_IP4_CONFIG_DHCP_FQDN "dhcp-fqdn" +</pre> +</div> +<hr> +<div class="refsect2"> +<a name="NM-SETTING-IP4-CONFIG-DHCP-VENDOR-CLASS-IDENTIFIER:CAPS"></a><h3>NM_SETTING_IP4_CONFIG_DHCP_VENDOR_CLASS_IDENTIFIER</h3> +<pre class="programlisting">#define NM_SETTING_IP4_CONFIG_DHCP_VENDOR_CLASS_IDENTIFIER "dhcp-vendor-class-identifier" </pre> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-IP4-CONFIG-METHOD-AUTO:CAPS"></a><h3>NM_SETTING_IP4_CONFIG_METHOD_AUTO</h3> -<pre class="programlisting">#define NM_SETTING_IP4_CONFIG_METHOD_AUTO "auto" +<pre class="programlisting">#define NM_SETTING_IP4_CONFIG_METHOD_AUTO "auto" </pre> <p>IPv4 configuration should be automatically determined via a method appropriate for the hardware interface, ie DHCP or PPP or some other device-specific @@ -274,7 +326,7 @@ operation.</p> <hr> <div class="refsect2"> <a name="NM-SETTING-IP4-CONFIG-METHOD-MANUAL:CAPS"></a><h3>NM_SETTING_IP4_CONFIG_METHOD_MANUAL</h3> -<pre class="programlisting">#define NM_SETTING_IP4_CONFIG_METHOD_MANUAL "manual" +<pre class="programlisting">#define NM_SETTING_IP4_CONFIG_METHOD_MANUAL "manual" </pre> <p>All necessary IPv4 configuration (addresses, prefix, DNS, etc) is specified in the setting's properties.</p> @@ -282,7 +334,7 @@ in the setting's properties.</p> <hr> <div class="refsect2"> <a name="NM-SETTING-IP4-CONFIG-METHOD-SHARED:CAPS"></a><h3>NM_SETTING_IP4_CONFIG_METHOD_SHARED</h3> -<pre class="programlisting">#define NM_SETTING_IP4_CONFIG_METHOD_SHARED "shared" +<pre class="programlisting">#define NM_SETTING_IP4_CONFIG_METHOD_SHARED "shared" </pre> <p>This connection specifies configuration that allows other computers to connect through it to the default network (usually the Internet). The @@ -294,7 +346,7 @@ through that interface to the default network.</p> <hr> <div class="refsect2"> <a name="NM-SETTING-IP4-CONFIG-METHOD-DISABLED:CAPS"></a><h3>NM_SETTING_IP4_CONFIG_METHOD_DISABLED</h3> -<pre class="programlisting">#define NM_SETTING_IP4_CONFIG_METHOD_DISABLED "disabled" +<pre class="programlisting">#define NM_SETTING_IP4_CONFIG_METHOD_DISABLED "disabled" </pre> <p>This connection does not use or require IPv4 address and it should be disabled.</p> </div> @@ -309,7 +361,7 @@ through that interface to the default network.</p> <a name="NMSettingIP4Config.property-details"></a><h2>Property Details</h2> <div class="refsect2"> <a name="NMSettingIP4Config--dhcp-client-id"></a><h3>The <code class="literal">“dhcp-client-id”</code> property</h3> -<pre class="programlisting"> “dhcp-client-id” <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre> +<pre class="programlisting"> “dhcp-client-id” <span class="type">char</span> *</pre> <p>A string sent to the DHCP server to identify the local machine which the DHCP server may use to customize the DHCP lease and options. When the property is a hex string ('aa:bb:cc') it is interpreted as a @@ -338,7 +390,7 @@ depends on the DHCP plugin.</p> <hr> <div class="refsect2"> <a name="NMSettingIP4Config--dhcp-fqdn"></a><h3>The <code class="literal">“dhcp-fqdn”</code> property</h3> -<pre class="programlisting"> “dhcp-fqdn” <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre> +<pre class="programlisting"> “dhcp-fqdn” <span class="type">char</span> *</pre> <p>If the <a class="link" href="NMSettingIPConfig.html#NMSettingIPConfig--dhcp-send-hostname" title="The “dhcp-send-hostname” property"><span class="type">“dhcp-send-hostname”</span></a> property is <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, then the specified FQDN will be sent to the DHCP server when acquiring a lease. This property and <a class="link" href="NMSettingIPConfig.html#NMSettingIPConfig--dhcp-hostname" title="The “dhcp-hostname” property"><span class="type">“dhcp-hostname”</span></a> are mutually exclusive and @@ -348,9 +400,24 @@ cannot be set at the same time.</p> <p>Default value: NULL</p> <p class="since">Since: 1.2</p> </div> +<hr> +<div class="refsect2"> +<a name="NMSettingIP4Config--dhcp-vendor-class-identifier"></a><h3>The <code class="literal">“dhcp-vendor-class-identifier”</code> property</h3> +<pre class="programlisting"> “dhcp-vendor-class-identifier” <span class="type">char</span> *</pre> +<p>The Vendor Class Identifier DHCP option (60). +Special characters in the data string may be escaped using C-style escapes, +nevertheless this property cannot contain nul bytes. +If the per-profile value is unspecified (the default), +a global connection default gets consulted. +If still unspecified, the DHCP option is not sent to the server.</p> +<p>Since 1.28</p> +<p>Owner: NMSettingIP4Config</p> +<p>Flags: Read / Write</p> +<p>Default value: NULL</p> +</div> </div> </div> <div class="footer"> -<hr>Generated by GTK-Doc V1.32</div> +<hr>Generated by GTK-Doc V1.33.1</div> </body> </html> \ No newline at end of file |