diff options
| author | Lennart Poettering <lennart@poettering.net> | 2015-09-04 09:05:52 +0200 |
|---|---|---|
| committer | Lennart Poettering <lennart@poettering.net> | 2015-09-04 09:07:31 +0200 |
| commit | 707b66c66381c899d7ef640e158ffdd5bcff4deb (patch) | |
| tree | 904cc3ecb07281497e16a0097d89286f84067225 /man/sd_machine_get_class.xml | |
| parent | 9da4cb2be260ed123f2676cb85cb350c527b1492 (diff) | |
| download | systemd-707b66c66381c899d7ef640e158ffdd5bcff4deb.tar.gz | |
sd-login: rework error handling
Makre sure we always return sensible errors for the various, following
the same rules, and document them in a comment in sd-login.c. Also,
update all relevant man pages accordingly.
Diffstat (limited to 'man/sd_machine_get_class.xml')
| -rw-r--r-- | man/sd_machine_get_class.xml | 31 |
1 files changed, 30 insertions, 1 deletions
diff --git a/man/sd_machine_get_class.xml b/man/sd_machine_get_class.xml index 5b881ccea1..9ad7f3fc66 100644 --- a/man/sd_machine_get_class.xml +++ b/man/sd_machine_get_class.xml @@ -56,7 +56,7 @@ <funcprototype> <funcdef>int <function>sd_machine_get_class</function></funcdef> <paramdef>const char* <parameter>machine</parameter></paramdef> - <paramdef>char *<parameter>class</parameter></paramdef> + <paramdef>char **<parameter>class</parameter></paramdef> </funcprototype> <funcprototype> @@ -99,6 +99,35 @@ </refsect1> <refsect1> + <title>Errors</title> + + <para>Returned errors may indicate the following problems:</para> + + <variablelist> + + <varlistentry> + <term><constant>-ENXIO</constant></term> + + <listitem><para>The specified machine does not exist or is currently not running.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><constant>-EINVAL</constant></term> + + <listitem><para>An input parameter was invalid (out of range, + or NULL, where that's not accepted).</para></listitem> + </varlistentry> + + <varlistentry> + <term><constant>-ENOMEM</constant></term> + + <listitem><para>Memory allocation failed.</para></listitem> + </varlistentry> + </variablelist> + </refsect1> + + <refsect1> <title>Notes</title> <para>The <function>sd_machine_get_class()</function> and |