2014-11-21 20:44:48 +01:00
|
|
|
|
<?xml version='1.0'?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*-->
|
2014-10-03 03:14:26 +02:00
|
|
|
|
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
|
2015-06-18 19:47:44 +02:00
|
|
|
|
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
|
2014-10-03 03:14:26 +02:00
|
|
|
|
|
|
|
|
|
<!--
|
2015-03-14 03:26:47 +01:00
|
|
|
|
This file is part of systemd.
|
2014-10-03 03:14:26 +02:00
|
|
|
|
|
2015-03-14 03:26:47 +01:00
|
|
|
|
Copyright 2014 Zbigniew Jędrzejewski-Szmek
|
2014-10-03 03:14:26 +02:00
|
|
|
|
|
2015-03-14 03:26:47 +01:00
|
|
|
|
systemd is free software; you can redistribute it and/or modify it
|
|
|
|
|
under the terms of the GNU Lesser General Public License as published by
|
|
|
|
|
the Free Software Foundation; either version 2.1 of the License, or
|
|
|
|
|
(at your option) any later version.
|
2014-10-03 03:14:26 +02:00
|
|
|
|
|
2015-03-14 03:26:47 +01:00
|
|
|
|
systemd is distributed in the hope that it will be useful, but
|
|
|
|
|
WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
|
|
|
Lesser General Public License for more details.
|
2014-10-03 03:14:26 +02:00
|
|
|
|
|
2015-03-14 03:26:47 +01:00
|
|
|
|
You should have received a copy of the GNU Lesser General Public License
|
|
|
|
|
along with systemd; If not, see <http://www.gnu.org/licenses/>.
|
2014-10-03 03:14:26 +02:00
|
|
|
|
-->
|
|
|
|
|
|
2015-06-17 12:32:33 +02:00
|
|
|
|
<refentry id="sd_event_set_name"
|
2014-10-03 03:14:26 +02:00
|
|
|
|
xmlns:xi="http://www.w3.org/2001/XInclude">
|
|
|
|
|
|
|
|
|
|
<refentryinfo>
|
|
|
|
|
<title>sd_event_set_name</title>
|
|
|
|
|
<productname>systemd</productname>
|
|
|
|
|
|
|
|
|
|
<authorgroup>
|
|
|
|
|
<author>
|
|
|
|
|
<contrib>More text</contrib>
|
|
|
|
|
<firstname>Zbigniew</firstname>
|
|
|
|
|
<surname>Jędrzejewski-Szmek</surname>
|
|
|
|
|
<email>zbyszek@in.waw.pl</email>
|
|
|
|
|
</author>
|
|
|
|
|
</authorgroup>
|
|
|
|
|
</refentryinfo>
|
|
|
|
|
|
|
|
|
|
<refmeta>
|
|
|
|
|
<refentrytitle>sd_event_set_name</refentrytitle>
|
|
|
|
|
<manvolnum>3</manvolnum>
|
|
|
|
|
</refmeta>
|
|
|
|
|
|
|
|
|
|
<refnamediv>
|
|
|
|
|
<refname>sd_event_set_name</refname>
|
|
|
|
|
<refname>sd_event_get_name</refname>
|
|
|
|
|
|
|
|
|
|
<refpurpose>Set human-readable names for event sources</refpurpose>
|
|
|
|
|
</refnamediv>
|
|
|
|
|
|
|
|
|
|
<refsynopsisdiv>
|
|
|
|
|
<funcsynopsis>
|
|
|
|
|
<funcsynopsisinfo>#include <systemd/sd-bus.h></funcsynopsisinfo>
|
|
|
|
|
|
|
|
|
|
<funcprototype>
|
|
|
|
|
<funcdef>int <function>sd_event_set_name</function></funcdef>
|
|
|
|
|
<paramdef>sd_event_source *<parameter>source</parameter></paramdef>
|
|
|
|
|
<paramdef>const char *<parameter>name</parameter></paramdef>
|
|
|
|
|
</funcprototype>
|
|
|
|
|
|
|
|
|
|
<funcprototype>
|
|
|
|
|
<funcdef>int <function>sd_event_get_name</function></funcdef>
|
|
|
|
|
<paramdef>sd_event_source *<parameter>source</parameter></paramdef>
|
|
|
|
|
<paramdef>const char **<parameter>name</parameter></paramdef>
|
|
|
|
|
</funcprototype>
|
|
|
|
|
|
|
|
|
|
</funcsynopsis>
|
|
|
|
|
</refsynopsisdiv>
|
|
|
|
|
|
|
|
|
|
<refsect1>
|
|
|
|
|
<title>Description</title>
|
|
|
|
|
|
|
|
|
|
<para><function>sd_event_set_name()</function> can be used to set
|
|
|
|
|
an arbitrary name for the event source
|
|
|
|
|
<parameter>source</parameter>. This name will be used in error
|
|
|
|
|
messages generated by
|
|
|
|
|
<citerefentry><refentrytitle>sd-event</refentrytitle><manvolnum>3</manvolnum></citerefentry>
|
2014-08-03 07:11:37 +02:00
|
|
|
|
for this source. The <parameter>name</parameter> must point
|
2014-10-03 03:14:26 +02:00
|
|
|
|
to a <constant>NUL</constant>-terminated string or be
|
|
|
|
|
<constant>NULL</constant>. In the latter case, the name will be
|
|
|
|
|
unset. The string is copied internally, so the
|
|
|
|
|
<parameter>name</parameter> argument is not referenced after the
|
|
|
|
|
function returns.</para>
|
|
|
|
|
|
|
|
|
|
<para><function>sd_event_set_name()</function> can be used to
|
|
|
|
|
query the current name assigned to source
|
|
|
|
|
<parameter>source</parameter>. It returns a pointer to the current
|
|
|
|
|
name (possibly <constant>NULL</constant>) in
|
|
|
|
|
<parameter>name</parameter>.</para>
|
|
|
|
|
</refsect1>
|
|
|
|
|
|
|
|
|
|
<refsect1>
|
|
|
|
|
<title>Return Value</title>
|
|
|
|
|
|
|
|
|
|
<para>On success, <function>sd_event_set_name()</function> and
|
|
|
|
|
<function>sd_event_get_name()</function> return a
|
|
|
|
|
non-negative integer. On failure, they return a negative
|
|
|
|
|
errno-style error code.</para>
|
|
|
|
|
</refsect1>
|
|
|
|
|
|
|
|
|
|
<refsect1>
|
|
|
|
|
<title>Errors</title>
|
|
|
|
|
|
|
|
|
|
<para>Returned errors may indicate the following problems:</para>
|
|
|
|
|
|
|
|
|
|
<variablelist>
|
|
|
|
|
<varlistentry>
|
|
|
|
|
<term><constant>-EINVAL</constant></term>
|
|
|
|
|
|
|
|
|
|
<listitem><para><parameter>source</parameter> is not a valid
|
|
|
|
|
pointer to an <structname>sd_event_source</structname>
|
|
|
|
|
structure or the <parameter>name</parameter> argument for
|
|
|
|
|
<function>sd_event_get_name()</function> is
|
|
|
|
|
<constant>NULL</constant>.</para></listitem>
|
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
|
|
<varlistentry>
|
|
|
|
|
<term><constant>-ENOMEM</constant></term>
|
|
|
|
|
|
|
|
|
|
<listitem><para>Not enough memory to copy the
|
|
|
|
|
name.</para></listitem>
|
|
|
|
|
</varlistentry>
|
|
|
|
|
</variablelist>
|
|
|
|
|
</refsect1>
|
|
|
|
|
|
|
|
|
|
<refsect1>
|
|
|
|
|
<title>Notes</title>
|
|
|
|
|
|
2014-08-03 07:11:37 +02:00
|
|
|
|
<para>The functions described here are available as a
|
2014-10-03 03:14:26 +02:00
|
|
|
|
shared library, which can be compiled and linked to with the
|
|
|
|
|
<constant>libsystemd</constant> <citerefentry
|
|
|
|
|
project='die-net'><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry>
|
|
|
|
|
file.</para>
|
|
|
|
|
</refsect1>
|
|
|
|
|
|
|
|
|
|
<refsect1>
|
|
|
|
|
<title>See Also</title>
|
|
|
|
|
|
|
|
|
|
<para>
|
|
|
|
|
<citerefentry><refentrytitle>sd-event</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
|
|
|
|
|
<citerefentry><refentrytitle>sd_event_add_time</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
|
|
|
|
|
<citerefentry><refentrytitle>sd_event_add_child</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
|
|
|
|
|
<citerefentry><refentrytitle>sd_event_add_signal</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
|
|
|
|
|
<citerefentry><refentrytitle>sd_event_add_defer</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
|
|
|
|
|
<citerefentry><refentrytitle>sd_event_run</refentrytitle><manvolnum>3</manvolnum></citerefentry>
|
|
|
|
|
</para>
|
|
|
|
|
</refsect1>
|
|
|
|
|
|
|
|
|
|
</refentry>
|