]>
Commit | Line | Data |
---|---|---|
514094f9 | 1 | <?xml version='1.0'?> |
dc83f27a LP |
2 | <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" |
3 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> | |
4 | ||
5 | <!-- | |
572eb058 | 6 | SPDX-License-Identifier: LGPL-2.1+ |
dc83f27a LP |
7 | --> |
8 | ||
9 | <refentry id="sd_event_source_get_event" xmlns:xi="http://www.w3.org/2001/XInclude"> | |
10 | ||
11 | <refentryinfo> | |
12 | <title>sd_event_source_get_event</title> | |
13 | <productname>systemd</productname> | |
dc83f27a LP |
14 | </refentryinfo> |
15 | ||
16 | <refmeta> | |
17 | <refentrytitle>sd_event_source_get_event</refentrytitle> | |
18 | <manvolnum>3</manvolnum> | |
19 | </refmeta> | |
20 | ||
21 | <refnamediv> | |
22 | <refname>sd_event_source_get_event</refname> | |
23 | ||
24 | <refpurpose>Retrieve the event loop of an event source</refpurpose> | |
25 | </refnamediv> | |
26 | ||
27 | <refsynopsisdiv> | |
28 | <funcsynopsis> | |
29 | <funcsynopsisinfo>#include <systemd/sd-event.h></funcsynopsisinfo> | |
30 | ||
31 | <funcprototype> | |
32 | <funcdef>sd_event* <function>sd_event_source_get_event</function></funcdef> | |
33 | <paramdef>sd_event_source *<parameter>source</parameter></paramdef> | |
34 | </funcprototype> | |
35 | ||
36 | </funcsynopsis> | |
37 | </refsynopsisdiv> | |
38 | ||
39 | <refsect1> | |
40 | <title>Description</title> | |
41 | ||
42 | <para><function>sd_event_source_get_event()</function> may be used | |
43 | to retrieve the event loop object the event source object specified | |
44 | as <parameter>source</parameter> is associated with. The event | |
45 | loop object is specified when creating an event source object with | |
46 | calls such as | |
47 | <citerefentry><refentrytitle>sd_event_add_io</refentrytitle><manvolnum>3</manvolnum></citerefentry> | |
48 | or | |
49 | <citerefentry><refentrytitle>sd_event_add_time</refentrytitle><manvolnum>3</manvolnum></citerefentry>.</para> | |
50 | </refsect1> | |
51 | ||
52 | <refsect1> | |
53 | <title>Return Value</title> | |
54 | ||
55 | <para>On success, <function>sd_event_source_get_event()</function> | |
56 | returns the associated event loop object. On failure, it returns | |
57 | NULL.</para> | |
58 | </refsect1> | |
59 | ||
60 | <xi:include href="libsystemd-pkgconfig.xml" /> | |
61 | ||
62 | <refsect1> | |
63 | <title>See Also</title> | |
64 | ||
65 | <para> | |
66 | <citerefentry><refentrytitle>sd-event</refentrytitle><manvolnum>3</manvolnum></citerefentry>, | |
67 | <citerefentry><refentrytitle>sd_event_add_io</refentrytitle><manvolnum>3</manvolnum></citerefentry>, | |
68 | <citerefentry><refentrytitle>sd_event_add_time</refentrytitle><manvolnum>3</manvolnum></citerefentry>, | |
dc83f27a | 69 | <citerefentry><refentrytitle>sd_event_add_signal</refentrytitle><manvolnum>3</manvolnum></citerefentry>, |
8274a30d LP |
70 | <citerefentry><refentrytitle>sd_event_add_child</refentrytitle><manvolnum>3</manvolnum></citerefentry>, |
71 | <citerefentry><refentrytitle>sd_event_add_inotify</refentrytitle><manvolnum>3</manvolnum></citerefentry>, | |
dc83f27a LP |
72 | <citerefentry><refentrytitle>sd_event_add_defer</refentrytitle><manvolnum>3</manvolnum></citerefentry>, |
73 | <citerefentry><refentrytitle>sd_event_source_set_userdata</refentrytitle><manvolnum>3</manvolnum></citerefentry> | |
74 | </para> | |
75 | </refsect1> | |
76 | ||
77 | </refentry> |