diff options
author | Zbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl> | 2018-11-16 08:43:43 +0100 |
---|---|---|
committer | Zbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl> | 2018-11-16 09:03:41 +0100 |
commit | 08c1eb0e3099b785b20b6a433f2b876e03c26bb9 (patch) | |
tree | 931d3ce2e853805293cac4c98b0e6d239c72077e /man | |
parent | 7d92a1a49080206983a0ea1884d9a2287e696bb7 (diff) | |
download | systemd-08c1eb0e3099b785b20b6a433f2b876e03c26bb9.tar.gz systemd-08c1eb0e3099b785b20b6a433f2b876e03c26bb9.tar.bz2 systemd-08c1eb0e3099b785b20b6a433f2b876e03c26bb9.zip |
sd-event: make sd_event_source_get_enabled return more info
Diffstat (limited to 'man')
-rw-r--r-- | man/sd_event_source_set_enabled.xml | 14 |
1 files changed, 8 insertions, 6 deletions
diff --git a/man/sd_event_source_set_enabled.xml b/man/sd_event_source_set_enabled.xml index 87c38707e1..73f01848d5 100644 --- a/man/sd_event_source_set_enabled.xml +++ b/man/sd_event_source_set_enabled.xml @@ -74,8 +74,10 @@ <para><function>sd_event_source_get_enabled()</function> may be used to query whether the event source object <parameter>source</parameter> is currently enabled or not. It - returns the enablement state in - <parameter>enabled</parameter>.</para> + returns the enablement state (one of <constant>SD_EVENT_ON</constant>, + <constant>SD_EVENT_OFF</constant>, <constant>SD_EVENT_ONESHOT</constant>) + in <parameter>enabled</parameter>, if it is not <constant>NULL</constant>. + It also returns true if the event source is not disabled.</para> <para>Event source objects are enabled when they are first created with calls such as @@ -100,10 +102,10 @@ <refsect1> <title>Return Value</title> - <para>On success, <function>sd_event_source_set_enabled()</function> and - <function>sd_event_source_get_enabled()</function> return a - non-negative integer. On failure, they return a negative - errno-style error code.</para> + <para>On success, <function>sd_event_source_set_enabled()</function> returns a non-negative + integer. <function>sd_event_source_get_enabled()</function> returns zero if the source is + disabled (<constant>SD_EVENT_OFF</constant>) and a positive integer otherwise. On failure, they + return a negative errno-style error code.</para> </refsect1> <refsect1> |