X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=man%2Fsd_bus_error.xml;h=9be474764b9d1566903a81b55e4261c1bbd4712c;hp=38bc30311b1d8c56b7f07c30c5f4ab91f57dc8b0;hb=f27e2d8c0c0c18d5a1be62c87ea89fcd4894fffa;hpb=71365a7754db5ff8e07941501063b1da2a4b4bd5 diff --git a/man/sd_bus_error.xml b/man/sd_bus_error.xml index 38bc30311..9be474764 100644 --- a/man/sd_bus_error.xml +++ b/man/sd_bus_error.xml @@ -21,7 +21,7 @@ You should have received a copy of the GNU Lesser General Public License along with systemd; If not, see . --> - + sd_bus_error @@ -54,7 +54,7 @@ along with systemd; If not, see . sd_bus_error_is_set sd_bus_error_has_name - libsystemd-bus error handling + sd-bus error handling @@ -231,10 +231,10 @@ along with systemd; If not, see . Description - sd_bus_error structure carries - information for a libsystemd-bus error. - Functions described below can be used to set and query fields in - this structure. Field name contains a + The sd_bus_error structure carries + information for a sd-bus error. The + functions described below can be used to set and query fields in + this structure. The name field contains a short identifier of an error. It should follow the rules for error names described in the D-Bus specification, subsection Valid @@ -251,16 +251,16 @@ along with systemd; If not, see . and the remaining ones to -ENXIO. Well-known D-Bus error names are available as constants SD_BUS_ERROR_FAILED, etc., listed above. If - name is NULL, it is is + name is NULL, it is assumed that no error occured, and 0 is returned. This means that this function may be conveniently used in a return statement. If e is not NULL, name and - message will be filled-in in the + message in the sd_bus_error structure - e points at. As described above, + e points at will be filled in. As described above, name may be NULL, which is treated as no error. Parameter message may also be @@ -297,16 +297,17 @@ along with systemd; If not, see . format and the arguments. sd_bus_error_get_errno is will convert - e->name to an errno-like value - using the same rules as sd_bus_error_set. - + e->name to an errno-like value using the + same rules as sd_bus_error_set. If + e is NULL, 0 will be + returned. sd_bus_error_copy will initialize dst using the values in e. If the strings in e were set using sd_bus_set_error_const, they will be shared. - Otherwie they wil be copied. + Otherwise, they will be copied. sd_bus_error_is_set will return true if e is @@ -342,7 +343,7 @@ along with systemd; If not, see . sd_bus_error_get_errno returns false when e is NULL, and a positive errno value mapped from - e->name otherwise. + e->name otherwise. sd_bus_error_copy returns 0 or a positive integer on success, and one of the negative error values @@ -350,12 +351,12 @@ along with systemd; If not, see . sd_bus_error_is_set returns true when e and - e->name are non-NULL, + e->name are non-NULL, false otherwise. sd_bus_error_has_name returns true when e is - non-NULL and e->name + non-NULL and e->name is equal to name, false otherwise. @@ -396,7 +397,7 @@ along with systemd; If not, see . sd_bus_set_error() and other functions described here are available as a shared library, which can be compiled and linked to with the - libsystemd-bus pkg-config1 + libsystemd pkg-config1 file.