blob: c2f1368916623c5652f7235a87abd9c9062060c4 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
|
'\" t
.TH "SD_BUS_LIST_NAMES" "3" "" "systemd 255" "sd_bus_list_names"
.\" -----------------------------------------------------------------
.\" * 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_bus_list_names \- Retrieve information about registered names on a bus
.SH "SYNOPSIS"
.sp
.ft B
.nf
#include <systemd/sd\-bus\&.h>
.fi
.ft
.HP \w'int\ sd_bus_list_names('u
.BI "int sd_bus_list_names(sd_bus\ *" "bus" ", char\ ***" "acquired" ", char\ ***" "activatable" ");"
.SH "DESCRIPTION"
.PP
\fBsd_bus_list_names()\fR
retrieves information about the registered names on a bus\&. If
\fIacquired\fR
is not
\fBNULL\fR, this function calls
\m[blue]\fBorg\&.freedesktop\&.DBus\&.ListNames\fR\m[]\&\s-2\u[1]\d\s+2
to retrieve the list of currently\-owned names on the bus\&. If
\fIacquired\fR
is not
\fBNULL\fR, the function calls
\m[blue]\fBorg\&.freedesktop\&.DBus\&.ListActivableNames\fR\m[]\&\s-2\u[2]\d\s+2
to retrieve the list of all names on the bus that can be activated\&. Note that ownership of the arrays returned by
\fBsd_bus_list_names()\fR
in
\fIacquired\fR
and
\fIactivatable\fR
is transferred to the caller and hence, the caller is responsible for freeing these arrays and their contents\&.
.SH "RETURN VALUE"
.PP
On success,
\fBsd_bus_list_names()\fR
returns a non\-negative integer\&. On failure, it returns a negative errno\-style error code\&.
.SS "Errors"
.PP
Returned errors may indicate the following problems:
.PP
\fB\-EINVAL\fR
.RS 4
\fIbus\fR
or both
\fIacquired\fR
and
\fIactivatable\fR
were
\fBNULL\fR\&.
.sp
Added in version 246\&.
.RE
.PP
\fB\-ENOPKG\fR
.RS 4
The bus cannot be resolved\&.
.sp
Added in version 246\&.
.RE
.PP
\fB\-ECHILD\fR
.RS 4
The bus was created in a different process, library or module instance\&.
.sp
Added in version 246\&.
.RE
.PP
\fB\-ENOMEM\fR
.RS 4
Memory allocation failed\&.
.sp
Added in version 246\&.
.RE
.PP
\fB\-ENOTCONN\fR
.RS 4
The bus is not connected\&.
.sp
Added in version 246\&.
.RE
.SH "NOTES"
.PP
Functions described here are available as a shared library, which can be compiled against and linked to with the
\fBlibsystemd\fR\ \&\fBpkg-config\fR(1)
file\&.
.PP
The code described here uses
\fBgetenv\fR(3), which is declared to be not multi\-thread\-safe\&. This means that the code calling the functions described here must not call
\fBsetenv\fR(3)
from a parallel thread\&. It is recommended to only do calls to
\fBsetenv()\fR
from an early phase of the program when no other threads have been started\&.
.SH "HISTORY"
.PP
\fBsd_bus_list_names()\fR
was added in version 246\&.
.SH "SEE ALSO"
.PP
\fBsystemd\fR(1),
\fBsd-bus\fR(3)
.SH "NOTES"
.IP " 1." 4
org.freedesktop.DBus.ListNames
.RS 4
\%https://dbus.freedesktop.org/doc/dbus-specification.html#bus-messages-list-names
.RE
.IP " 2." 4
org.freedesktop.DBus.ListActivableNames
.RS 4
\%https://dbus.freedesktop.org/doc/dbus-specification.html#bus-messages-list-activatable-names
.RE
|
