mirror of
https://git.proxmox.com/git/systemd
synced 2025-06-05 18:23:08 +00:00
95 lines
2.8 KiB
Groff
95 lines
2.8 KiB
Groff
'\" t
|
|
.TH "SD_EVENT_SET_NAME" "3" "" "systemd 219" "sd_event_set_name"
|
|
.\" -----------------------------------------------------------------
|
|
.\" * Define some portability stuff
|
|
.\" -----------------------------------------------------------------
|
|
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
.\" http://bugs.debian.org/507673
|
|
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
|
|
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
.ie \n(.g .ds Aq \(aq
|
|
.el .ds Aq '
|
|
.\" -----------------------------------------------------------------
|
|
.\" * set default formatting
|
|
.\" -----------------------------------------------------------------
|
|
.\" disable hyphenation
|
|
.nh
|
|
.\" disable justification (adjust text to left margin only)
|
|
.ad l
|
|
.\" -----------------------------------------------------------------
|
|
.\" * MAIN CONTENT STARTS HERE *
|
|
.\" -----------------------------------------------------------------
|
|
.SH "NAME"
|
|
sd_event_set_name, sd_event_get_name \- Set human\-readable names for event sources
|
|
.SH "SYNOPSIS"
|
|
.sp
|
|
.ft B
|
|
.nf
|
|
#include <systemd/sd\-bus\&.h>
|
|
.fi
|
|
.ft
|
|
.HP \w'int\ sd_event_set_name('u
|
|
.BI "int sd_event_set_name(sd_event_source\ *" "source" ", const\ char\ *" "name" ");"
|
|
.HP \w'int\ sd_event_get_name('u
|
|
.BI "int sd_event_get_name(sd_event_source\ *" "source" ", const\ char\ **" "name" ");"
|
|
.SH "DESCRIPTION"
|
|
.PP
|
|
\fBsd_event_set_name()\fR
|
|
can be used to set an arbitrary name for the event source
|
|
\fIsource\fR\&. This name will be used in error messages generated by
|
|
\fBsd-event\fR(3)
|
|
for this source\&. Specified
|
|
\fIname\fR
|
|
must point to a
|
|
\fBNUL\fR\-terminated string or be
|
|
\fBNULL\fR\&. In the latter case, the name will be unset\&. The string is copied internally, so the
|
|
\fIname\fR
|
|
argument is not referenced after the function returns\&.
|
|
.PP
|
|
\fBsd_event_set_name()\fR
|
|
can be used to query the current name assigned to source
|
|
\fIsource\fR\&. It returns a pointer to the current name (possibly
|
|
\fBNULL\fR) in
|
|
\fIname\fR\&.
|
|
.SH "RETURN VALUE"
|
|
.PP
|
|
On success,
|
|
\fBsd_event_set_name()\fR
|
|
and
|
|
\fBsd_event_get_name()\fR
|
|
return a non\-negative integer\&. On failure, they return a negative errno\-style error code\&.
|
|
.SH "ERRORS"
|
|
.PP
|
|
Returned errors may indicate the following problems:
|
|
.PP
|
|
\fB\-EINVAL\fR
|
|
.RS 4
|
|
\fIsource\fR
|
|
is not a valid pointer to an
|
|
sd_event_source
|
|
structure or the
|
|
\fIname\fR
|
|
argument for
|
|
\fBsd_event_get_name()\fR
|
|
is
|
|
\fBNULL\fR\&.
|
|
.RE
|
|
.PP
|
|
\fB\-ENOMEM\fR
|
|
.RS 4
|
|
Not enough memory to copy the name\&.
|
|
.RE
|
|
.SH "NOTES"
|
|
.PP
|
|
Functions described here are available as a shared library, which can be compiled and linked to with the
|
|
\fBlibsystemd\fR\ \&\fBpkg-config\fR(1)
|
|
file\&.
|
|
.SH "SEE ALSO"
|
|
.PP
|
|
\fBsd-event\fR(3),
|
|
\fBsd_event_add_time\fR(3),
|
|
\fBsd_event_add_child\fR(3),
|
|
\fBsd_event_add_signal\fR(3),
|
|
\fBsd_event_add_defer\fR(3),
|
|
\fBsd_event_run\fR(3)
|