diff options
Diffstat (limited to 'docs/libnm/html/NMVpnEditorPlugin.html')
| -rw-r--r-- | docs/libnm/html/NMVpnEditorPlugin.html | 44 |
1 files changed, 23 insertions, 21 deletions
diff --git a/docs/libnm/html/NMVpnEditorPlugin.html b/docs/libnm/html/NMVpnEditorPlugin.html index 13cc3db2..ad04d23d 100644 --- a/docs/libnm/html/NMVpnEditorPlugin.html +++ b/docs/libnm/html/NMVpnEditorPlugin.html @@ -77,7 +77,7 @@ </tr> <tr> <td class="function_type"> -<a href="https://developer.gnome.org/libnm-util/0.9/NMConnection.html"><span class="returnvalue">NMConnection</span></a> * +<a href="/usr/share/gtk-doc/html/libnm-util/NMConnection.html"><span class="returnvalue">NMConnection</span></a> * </td> <td class="function_name"> <a class="link" href="NMVpnEditorPlugin.html#nm-vpn-editor-plugin-import" title="nm_vpn_editor_plugin_import ()">nm_vpn_editor_plugin_import</a> <span class="c_punctuation">()</span> @@ -226,7 +226,7 @@ nm_vpn_editor_plugin_factory (<em class="parameter"><code><span class="type">GEr <a name="nm-vpn-editor-plugin-get-editor"></a><h3>nm_vpn_editor_plugin_get_editor ()</h3> <pre class="programlisting"><a class="link" href="NMVpnEditorPlugin.html#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 href="https://developer.gnome.org/libnm-util/0.9/NMConnection.html"><span class="type">NMConnection</span></a> *connection</code></em>, + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/libnm-util/NMConnection.html"><span class="type">NMConnection</span></a> *connection</code></em>, <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> <div class="refsect3"> <a name="id-1.7.3.11.4.4"></a><h4>Parameters</h4> @@ -244,7 +244,7 @@ nm_vpn_editor_plugin_get_editor (<em class="parameter"><code><a class="link" hre </tr> <tr> <td class="parameter_name"><p>connection</p></td> -<td class="parameter_description"><p>the <a href="https://developer.gnome.org/libnm-util/0.9/NMConnection.html"><span class="type">NMConnection</span></a> to be edited</p></td> +<td class="parameter_description"><p>the <a href="/usr/share/gtk-doc/html/libnm-util/NMConnection.html"><span class="type">NMConnection</span></a> to be edited</p></td> <td class="parameter_annotations"> </td> </tr> <tr> @@ -270,7 +270,7 @@ nm_vpn_editor_plugin_get_capabilities (<em class="parameter"><code><a class="lin <hr> <div class="refsect2"> <a name="nm-vpn-editor-plugin-import"></a><h3>nm_vpn_editor_plugin_import ()</h3> -<pre class="programlisting"><a href="https://developer.gnome.org/libnm-util/0.9/NMConnection.html"><span class="returnvalue">NMConnection</span></a> * +<pre class="programlisting"><a href="/usr/share/gtk-doc/html/libnm-util/NMConnection.html"><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> @@ -290,7 +290,7 @@ nm_vpn_editor_plugin_import (<em class="parameter"><code><a class="link" href="N </tr> <tr> <td class="parameter_name"><p>path</p></td> -<td class="parameter_description"><p>full path to the file to attempt to read into a new <a href="https://developer.gnome.org/libnm-util/0.9/NMConnection.html"><span class="type">NMConnection</span></a></p></td> +<td class="parameter_description"><p>full path to the file to attempt to read into a new <a href="/usr/share/gtk-doc/html/libnm-util/NMConnection.html"><span class="type">NMConnection</span></a></p></td> <td class="parameter_annotations"> </td> </tr> <tr> @@ -303,7 +303,7 @@ nm_vpn_editor_plugin_import (<em class="parameter"><code><a class="link" href="N </div> <div class="refsect3"> <a name="id-1.7.3.11.6.5"></a><h4>Returns</h4> -<p> a new <a href="https://developer.gnome.org/libnm-util/0.9/NMConnection.html"><span class="type">NMConnection</span></a> imported from <em class="parameter"><code>path</code></em> +<p> a new <a href="/usr/share/gtk-doc/html/libnm-util/NMConnection.html"><span class="type">NMConnection</span></a> imported from <em class="parameter"><code>path</code></em> , or <code class="literal">NULL</code> on error or if the file at <em class="parameter"><code>path</code></em> was not recognized by this plugin. </p> @@ -316,7 +316,7 @@ was not recognized by this plugin. </p> <pre class="programlisting"><span class="returnvalue">gboolean</span> 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 href="https://developer.gnome.org/libnm-util/0.9/NMConnection.html"><span class="type">NMConnection</span></a> *connection</code></em>, + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/libnm-util/NMConnection.html"><span class="type">NMConnection</span></a> *connection</code></em>, <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> </div> <hr> @@ -325,24 +325,29 @@ nm_vpn_editor_plugin_export (<em class="parameter"><code><a class="link" href="N <pre class="programlisting"><span class="returnvalue">char</span> * nm_vpn_editor_plugin_get_suggested_filename (<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 href="https://developer.gnome.org/libnm-util/0.9/NMConnection.html"><span class="type">NMConnection</span></a> *connection</code></em>);</pre> + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/libnm-util/NMConnection.html"><span class="type">NMConnection</span></a> *connection</code></em>);</pre> </div> <hr> <div class="refsect2"> <a name="nm-vpn-editor-plugin-load-from-file"></a><h3>nm_vpn_editor_plugin_load_from_file ()</h3> <pre class="programlisting"><a class="link" href="NMVpnEditorPlugin.html" title="NMVpnEditorPlugin"><span class="returnvalue">NMVpnEditorPlugin</span></a> * -nm_vpn_editor_plugin_load_from_file (<em class="parameter"><code>const <span class="type">char</span> *plugin_filename</code></em>, +nm_vpn_editor_plugin_load_from_file (<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">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> -<p>Load the shared libary <em class="parameter"><code>plugin_filename</code></em> +<p>Load the shared libary <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> instace via the <a class="link" href="NMVpnEditorPlugin.html#NMVpnEditorPluginFactory" title="NMVpnEditorPluginFactory ()"><span class="type">NMVpnEditorPluginFactory</span></a> function.</p> +<p>If <em class="parameter"><code>plugin_name</code></em> + is not an absolute path name, it assumes the file +is in the plugin directory of NetworkManager. In any case, the call +will do certain checks on the file before passing it to dlopen. +A consequence for that is, that you cannot omit the ".so" suffix.</p> <div class="refsect3"> -<a name="id-1.7.3.11.9.5"></a><h4>Parameters</h4> +<a name="id-1.7.3.11.9.6"></a><h4>Parameters</h4> <div class="informaltable"><table width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> @@ -351,14 +356,11 @@ function.</p> </colgroup> <tbody> <tr> -<td class="parameter_name"><p>plugin_filename</p></td> -<td class="parameter_description"><p>The path to the share library to load. -Apply some common heuristics to find the library, such as -appending "so" file ending. -If the path is not an absolute path or no matching module -can be found, lookup inside a directory defined at compile time. -Due to this, <em class="parameter"><code>check_file</code></em> -might be called for two different paths.</p></td> +<td class="parameter_name"><p>plugin_name</p></td> +<td class="parameter_description"><p>The path or name of the shared library to load. +The path must either be an absolute filename to an existing file. +Alternatively, it can be the name (without path) of a library in the +plugin directory of NetworkManager.</p></td> <td class="parameter_annotations"> </td> </tr> <tr> @@ -396,7 +398,7 @@ loading the shared library. </p></td> </table></div> </div> <div class="refsect3"> -<a name="id-1.7.3.11.9.6"></a><h4>Returns</h4> +<a name="id-1.7.3.11.9.7"></a><h4>Returns</h4> <p> a new plugin instance or <code class="literal">NULL</code> on error. </p> <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> </div> @@ -520,7 +522,7 @@ 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 href="https://developer.gnome.org/libnm-util/0.9/NMConnection.html"><span class="type">NMConnection</span></a> object. On error, return <code class="literal">NULL</code> and +success, return a partial <a href="/usr/share/gtk-doc/html/libnm-util/NMConnection.html"><span class="type">NMConnection</span></a> object. On error, return <code class="literal">NULL</code> 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 |