diff options
| author | Michael Biebl <biebl@debian.org> | 2024-07-05 18:15:13 +0200 |
|---|---|---|
| committer | Michael Biebl <biebl@debian.org> | 2024-07-05 18:15:13 +0200 |
| commit | 58affb29b8386d6d26359da604a64fefe7ae0a60 (patch) | |
| tree | 6c0c9b519e431ca178070c89f516dbaa660bbddb /docs/libnm/html/NMVpnEditorPlugin.html | |
| parent | 8e2fde558a5af5c3b03a5112dbd8f9085c5a8369 (diff) | |
New upstream version 1.48.4 upstream/1.48.4
Diffstat (limited to 'docs/libnm/html/NMVpnEditorPlugin.html')
| -rw-r--r-- | docs/libnm/html/NMVpnEditorPlugin.html | 74 |
1 files changed, 37 insertions, 37 deletions
diff --git a/docs/libnm/html/NMVpnEditorPlugin.html b/docs/libnm/html/NMVpnEditorPlugin.html index ed012391..3f05cc5b 100644 --- a/docs/libnm/html/NMVpnEditorPlugin.html +++ b/docs/libnm/html/NMVpnEditorPlugin.html @@ -8,7 +8,7 @@ <link rel="up" href="ch06.html" title="VPN Plugin API Reference"> <link rel="prev" href="NMVpnEditor.html" title="NMVpnEditor"> <link rel="next" href="NMVpnPluginOld.html" title="NMVpnPluginOld"> -<meta name="generator" content="GTK-Doc V1.34.0 (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"> @@ -78,7 +78,7 @@ </tr> <tr> <td class="function_type"> -<span class="returnvalue">gsize</span> +<a href="../glib/glib-Basic-Types.html#gsize"><span class="returnvalue">gsize</span></a> </td> <td class="function_name"> <a class="link" href="NMVpnEditorPlugin.html#nm-vpn-editor-plugin-get-vt" title="nm_vpn_editor_plugin_get_vt ()">nm_vpn_editor_plugin_get_vt</a> <span class="c_punctuation">()</span> @@ -94,7 +94,7 @@ </tr> <tr> <td class="function_type"> -<span class="returnvalue">gboolean</span> +<a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> </td> <td class="function_name"> <a class="link" href="NMVpnEditorPlugin.html#nm-vpn-editor-plugin-export" title="nm_vpn_editor_plugin_export ()">nm_vpn_editor_plugin_export</a> <span class="c_punctuation">()</span> @@ -160,7 +160,7 @@ </tr> <tr> <td class="property_type"> -<span class="type">GKeyFile</span> *</td> +<a href="../glib/glib-Key-value-file-parser.html#GKeyFile"><span class="type">GKeyFile</span></a> *</td> <td class="property_name"><a class="link" href="NMVpnEditorPlugin.html#NMVpnPluginInfo--keyfile" title="The “keyfile” property">keyfile</a></td> <td class="property_flags">Write / Construct Only</td> </tr> @@ -202,7 +202,7 @@ <tbody><tr> <td class="signal_type"><span class="returnvalue">void</span></td> <td class="signal_name"><a class="link" href="NMVpnEditorPlugin.html#NMVpnEditor-changed" title="The “changed” signal">changed</a></td> -<td class="signal_flags">Run First</td> +<td class="signal_flags"><a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></td> </tr></tbody> </table></div> </div> @@ -256,7 +256,7 @@ <a href="/usr/share/gtk-doc/html/gobject/GTypeModule.html">GInterface</a> <span class="lineart">├──</span> NMVpnEditor <span class="lineart">╰──</span> NMVpnEditorPlugin - GObject + <a href="../gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a> <span class="lineart">╰──</span> NMVpnPluginInfo </pre> </div> @@ -264,13 +264,13 @@ <a name="NMVpnEditorPlugin.prerequisites"></a><h2>Prerequisites</h2> <p> NMVpnEditor requires - GObject.</p> + <a href="../gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>.</p> </div> <div class="refsect1"> <a name="NMVpnEditorPlugin.implemented-interfaces"></a><h2>Implemented Interfaces</h2> <p> NMVpnPluginInfo implements - GInitable.</p> + <a href="../gio/GInitable.html#GInitable-struct">GInitable</a>.</p> </div> <div class="refsect1"> <a name="NMVpnEditorPlugin.description"></a><h2>Description</h2> @@ -280,13 +280,13 @@ NMVpnPluginInfo implements <div class="refsect2"> <a name="NMVpnEditorPluginFactory"></a><h3>NMVpnEditorPluginFactory ()</h3> <pre class="programlisting"><a class="link" href="NMVpnEditorPlugin.html" title="NMVpnEditorPlugin"><span class="returnvalue">NMVpnEditorPlugin</span></a> * -<span class="c_punctuation">(</span>*NMVpnEditorPluginFactory<span class="c_punctuation">)</span> (<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> +<span class="c_punctuation">(</span>*NMVpnEditorPluginFactory<span class="c_punctuation">)</span> (<em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre> </div> <hr> <div class="refsect2"> <a name="nm-vpn-editor-plugin-factory"></a><h3>nm_vpn_editor_plugin_factory ()</h3> <pre class="programlisting"><a class="link" href="NMVpnEditorPlugin.html" title="NMVpnEditorPlugin"><span class="returnvalue">NMVpnEditorPlugin</span></a> * -nm_vpn_editor_plugin_factory (<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> +nm_vpn_editor_plugin_factory (<em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre> </div> <hr> <div class="refsect2"> @@ -294,7 +294,7 @@ nm_vpn_editor_plugin_factory (<em class="parameter"><code><span class="type">GEr <pre class="programlisting"><a class="link" href="NMVpnEditor.html" title="NMVpnEditor"><span class="returnvalue">NMVpnEditor</span></a> * nm_vpn_editor_plugin_get_editor (<em class="parameter"><code><a class="link" href="NMVpnEditorPlugin.html" title="NMVpnEditorPlugin"><span class="type">NMVpnEditorPlugin</span></a> *plugin</code></em>, <em class="parameter"><code><a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a> *connection</code></em>, - <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> + <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre> <div class="refsect3"> <a name="nm-vpn-editor-plugin-get-editor.parameters"></a><h4>Parameters</h4> <div class="informaltable"><table class="informaltable" width="100%" border="0"> @@ -316,7 +316,7 @@ nm_vpn_editor_plugin_get_editor (<em class="parameter"><code><a class="link" hre </tr> <tr> <td class="parameter_name"><p>error</p></td> -<td class="parameter_description"><p>on return, an error or <code class="literal">NULL</code></p></td> +<td class="parameter_description"><p>on return, an error or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td> <td class="parameter_annotations"> </td> </tr> </tbody> @@ -324,7 +324,7 @@ nm_vpn_editor_plugin_get_editor (<em class="parameter"><code><a class="link" hre </div> <div class="refsect3"> <a name="nm-vpn-editor-plugin-get-editor.returns"></a><h4>Returns</h4> -<p>a new <a class="link" href="NMVpnEditor.html" title="NMVpnEditor"><span class="type">NMVpnEditor</span></a> or <code class="literal">NULL</code> on error. </p> +<p>a new <a class="link" href="NMVpnEditor.html" title="NMVpnEditor"><span class="type">NMVpnEditor</span></a> or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> on error. </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> @@ -337,10 +337,10 @@ nm_vpn_editor_plugin_get_capabilities (<em class="parameter"><code><a class="lin <hr> <div class="refsect2"> <a name="nm-vpn-editor-plugin-get-vt"></a><h3>nm_vpn_editor_plugin_get_vt ()</h3> -<pre class="programlisting"><span class="returnvalue">gsize</span> +<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gsize"><span class="returnvalue">gsize</span></a> nm_vpn_editor_plugin_get_vt (<em class="parameter"><code><a class="link" href="NMVpnEditorPlugin.html" title="NMVpnEditorPlugin"><span class="type">NMVpnEditorPlugin</span></a> *plugin</code></em>, <em class="parameter"><code><a class="link" href="NMVpnEditorPlugin.html#NMVpnEditorPluginVT" title="NMVpnEditorPluginVT"><span class="type">NMVpnEditorPluginVT</span></a> *vt</code></em>, - <em class="parameter"><code><span class="type">gsize</span> vt_size</code></em>);</pre> + <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gsize"><span class="type">gsize</span></a> vt_size</code></em>);</pre> <p>Returns an opaque VT function table for the plugin to extend functionality. The actual meaning of NMVpnEditorPluginVT is not defined in public API of libnm, instead it must be agreed by @@ -387,7 +387,7 @@ size of plugin's VT.</p></td> <pre class="programlisting"><a class="link" href="NMConnection.html" title="NMConnection"><span class="returnvalue">NMConnection</span></a> * nm_vpn_editor_plugin_import (<em class="parameter"><code><a class="link" href="NMVpnEditorPlugin.html" title="NMVpnEditorPlugin"><span class="type">NMVpnEditorPlugin</span></a> *plugin</code></em>, <em class="parameter"><code>const <span class="type">char</span> *path</code></em>, - <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> + <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre> <div class="refsect3"> <a name="nm-vpn-editor-plugin-import.parameters"></a><h4>Parameters</h4> <div class="informaltable"><table class="informaltable" width="100%" border="0"> @@ -409,7 +409,7 @@ nm_vpn_editor_plugin_import (<em class="parameter"><code><a class="link" href="N </tr> <tr> <td class="parameter_name"><p>error</p></td> -<td class="parameter_description"><p>on return, an error or <code class="literal">NULL</code></p></td> +<td class="parameter_description"><p>on return, an error or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td> <td class="parameter_annotations"> </td> </tr> </tbody> @@ -418,7 +418,7 @@ nm_vpn_editor_plugin_import (<em class="parameter"><code><a class="link" href="N <div class="refsect3"> <a name="nm-vpn-editor-plugin-import.returns"></a><h4>Returns</h4> <p>a new <a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a> imported from <em class="parameter"><code>path</code></em> -, or <code class="literal">NULL</code> +, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> on error or if the file at <em class="parameter"><code>path</code></em> was not recognized by this plugin. </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> @@ -427,11 +427,11 @@ was not recognized by this plugin. </p> <hr> <div class="refsect2"> <a name="nm-vpn-editor-plugin-export"></a><h3>nm_vpn_editor_plugin_export ()</h3> -<pre class="programlisting"><span class="returnvalue">gboolean</span> +<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> nm_vpn_editor_plugin_export (<em class="parameter"><code><a class="link" href="NMVpnEditorPlugin.html" title="NMVpnEditorPlugin"><span class="type">NMVpnEditorPlugin</span></a> *plugin</code></em>, <em class="parameter"><code>const <span class="type">char</span> *path</code></em>, <em class="parameter"><code><a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a> *connection</code></em>, - <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> + <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre> </div> <hr> <div class="refsect2"> @@ -449,8 +449,8 @@ nm_vpn_editor_plugin_load_from_file (<em class="parameter"><code>const <span cla <em class="parameter"><code>const <span class="type">char</span> *check_service</code></em>, <em class="parameter"><code><span class="type">int</span> check_owner</code></em>, <em class="parameter"><code><a class="link" href="libnm-nm-utils.html#NMUtilsCheckFilePredicate" title="NMUtilsCheckFilePredicate ()"><span class="type">NMUtilsCheckFilePredicate</span></a> check_file</code></em>, - <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>, - <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> + <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>, + <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre> <p>Load the shared library <em class="parameter"><code>plugin_name</code></em> and create a new <a class="link" href="NMVpnEditorPlugin.html" title="NMVpnEditorPlugin"><span class="type">NMVpnEditorPlugin</span></a> instance via the <a class="link" href="NMVpnEditorPlugin.html#NMVpnEditorPluginFactory" title="NMVpnEditorPluginFactory ()"><span class="type">NMVpnEditorPluginFactory</span></a> @@ -514,7 +514,7 @@ loading the shared library. </p></td> </div> <div class="refsect3"> <a name="nm-vpn-editor-plugin-load-from-file.returns"></a><h4>Returns</h4> -<p>a new plugin instance or <code class="literal">NULL</code> on error. </p> +<p>a new plugin instance or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> on error. </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> <p class="since">Since: 1.2</p> @@ -525,7 +525,7 @@ loading the shared library. </p></td> <pre class="programlisting"><a class="link" href="NMVpnEditorPlugin.html" title="NMVpnEditorPlugin"><span class="returnvalue">NMVpnEditorPlugin</span></a> * nm_vpn_editor_plugin_load (<em class="parameter"><code>const <span class="type">char</span> *plugin_name</code></em>, <em class="parameter"><code>const <span class="type">char</span> *check_service</code></em>, - <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> + <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre> <p>Load the shared library <em class="parameter"><code>plugin_name</code></em> and create a new <a class="link" href="NMVpnEditorPlugin.html" title="NMVpnEditorPlugin"><span class="type">NMVpnEditorPlugin</span></a> instance via the <a class="link" href="NMVpnEditorPlugin.html#NMVpnEditorPluginFactory" title="NMVpnEditorPluginFactory ()"><span class="type">NMVpnEditorPluginFactory</span></a> @@ -566,7 +566,7 @@ the given service.</p></td> </div> <div class="refsect3"> <a name="nm-vpn-editor-plugin-load.returns"></a><h4>Returns</h4> -<p>a new plugin instance or <code class="literal">NULL</code> on error. </p> +<p>a new plugin instance or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> on error. </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> <p class="since">Since: 1.4</p> @@ -624,7 +624,7 @@ reference as the plugin-info might also reference the editor-plugin.</p> </tr> <tr> <td class="parameter_name"><p>plugin_info</p></td> -<td class="parameter_description"><p>a <a class="link" href="NMVpnPluginInfo.html" title="NMVpnPluginInfo"><span class="type">NMVpnPluginInfo</span></a> instance or <code class="literal">NULL</code>. </p></td> +<td class="parameter_description"><p>a <a class="link" href="NMVpnPluginInfo.html" title="NMVpnPluginInfo"><span class="type">NMVpnPluginInfo</span></a> instance or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td> <td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> </tr> </tbody> @@ -734,7 +734,7 @@ reference as the plugin-info might also reference the editor-plugin.</p> <tr> <td class="struct_member_name"><p><em class="structfield"><code><a name="NMVpnEditorPluginInterface.get-editor"></a>get_editor</code></em> ()</p></td> <td class="struct_member_description"><p>returns an <a class="link" href="NMVpnEditor.html" title="NMVpnEditor"><span class="type">NMVpnEditor</span></a>, pre-filled with values from <em class="parameter"><code>connection</code></em> -if non-<code class="literal">NULL</code>.</p></td> +if non-<a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p></td> <td class="struct_member_annotations"> </td> </tr> <tr> @@ -745,27 +745,27 @@ if non-<code class="literal">NULL</code>.</p></td> <tr> <td class="struct_member_name"><p><em class="structfield"><code><a name="NMVpnEditorPluginInterface.import-from-file"></a>import_from_file</code></em> ()</p></td> <td class="struct_member_description"><p>Try to import a connection from the specified path. On -success, return a partial <a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a> object. On error, return <code class="literal">NULL</code> and +success, return a partial <a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a> object. On error, return <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> and set <em class="parameter"><code>error</code></em> with additional information. Note that <em class="parameter"><code>error</code></em> -can be <code class="literal">NULL</code>, in +can be <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, in which case no additional error information should be provided.</p></td> <td class="struct_member_annotations"> </td> </tr> <tr> <td class="struct_member_name"><p><em class="structfield"><code><a name="NMVpnEditorPluginInterface.export-to-file"></a>export_to_file</code></em> ()</p></td> <td class="struct_member_description"><p>Export the given connection to the specified path. Return -<code class="literal">TRUE</code> on success. On error, return <code class="literal">FALSE</code> and set <em class="parameter"><code>error</code></em> +<a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success. On error, return <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> and set <em class="parameter"><code>error</code></em> with additional error information. Note that <em class="parameter"><code>error</code></em> -can be <code class="literal">NULL</code>, in which case no +can be <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, in which case no additional error information should be provided.</p></td> <td class="struct_member_annotations"> </td> </tr> <tr> <td class="struct_member_name"><p><em class="structfield"><code><a name="NMVpnEditorPluginInterface.get-suggested-filename"></a>get_suggested_filename</code></em> ()</p></td> <td class="struct_member_description"><p>For a given connection, return a suggested file -name. Returned value will be <code class="literal">NULL</code> or a suggested file name to be freed by +name. Returned value will be <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> or a suggested file name to be freed by the caller.</p></td> <td class="struct_member_annotations"> </td> </tr> @@ -806,7 +806,7 @@ the plugin, without requiring to update libnm. Used by <a class="link" href="NMV <a name="NMVpnPluginInfo--filename"></a><h3>The <code class="literal">“filename”</code> property</h3> <pre class="programlisting"> “filename” <span class="type">char</span> *</pre> <p>The filename from which the info was loaded. -Can be <code class="literal">NULL</code> if the instance was not loaded from +Can be <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if the instance was not loaded from a file (i.e. the keyfile instance was passed to the constructor).</p> <p>Owner: NMVpnPluginInfo</p> @@ -817,7 +817,7 @@ constructor).</p> <hr> <div class="refsect2"> <a name="NMVpnPluginInfo--keyfile"></a><h3>The <code class="literal">“keyfile”</code> property</h3> -<pre class="programlisting"> “keyfile” <span class="type">GKeyFile</span> *</pre> +<pre class="programlisting"> “keyfile” <a href="../glib/glib-Key-value-file-parser.html#GKeyFile"><span class="type">GKeyFile</span></a> *</pre> <p>Initialize the instance with a different keyfile instance. When passing a keyfile instance, the constructor will not try to read from filename.</p> @@ -869,12 +869,12 @@ try to read from filename.</p> <a name="NMVpnEditor-changed"></a><h3>The <code class="literal">“changed”</code> signal</h3> <pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="NMVpnEditor.html" title="NMVpnEditor"><span class="type">NMVpnEditor</span></a> *nmvpneditor, - <span class="type">gpointer</span> user_data)</pre> -<p>Flags: Run First</p> + <a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre> +<p>Flags: <a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></p> </div> </div> </div> <div class="footer"> -<hr>Generated by GTK-Doc V1.34.0</div> +<hr>Generated by GTK-Doc V1.33.1</div> </body> </html> \ No newline at end of file |