X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=man%2Fsd_bus_error.xml;h=aba80832d29b58e000f64456e0f3954fe016ed7e;hp=671df441ea408546c404c42de9c6ad587b9fe96e;hb=f280bcfb21aacce03abf17b3ad732c1351df42b9;hpb=66f756d437658cc464bfb5647c97efd0cf77f933 diff --git a/man/sd_bus_error.xml b/man/sd_bus_error.xml index 671df441e..aba80832d 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 @@ -232,8 +232,8 @@ along with systemd; If not, see . Description The sd_bus_error structure carries - information for a sd-bus error. - Functions described below can be used to set and query fields in + 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 . sd_bus_error_set will return an errno-like negative value returned based on parameter name (see - errno3). + errno3). Various well-known D-Bus errors are converted to specific values, 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 - assumed that no error occured, and 0 is returned. This means that + assumed that no error occurred, and 0 is returned. This means that this function may be conveniently used in a return statement. @@ -270,7 +270,7 @@ along with systemd; If not, see . sd_bus_error_setf is similar to sd_bus_error_set, but takes a - printf3 + printf3 format string and corresponding arguments to generate message. @@ -291,13 +291,13 @@ along with systemd; If not, see . sd_bus_error_set_errnof is similar to sd_bus_error_set_errno, but in addition to name, takes a - printf3 + printf3 format and corresponding arguments. name will be generated from format and the arguments. - sd_bus_error_get_errno is will convert - e->name to an errno-like value using the + sd_bus_error_get_errno will convert + e->name to an errno-like value using the same rules as sd_bus_error_set. If e is NULL, 0 will be returned. @@ -322,7 +322,7 @@ along with systemd; If not, see . sd_bus_error_free will destroy resources held by e. The parameter itself will not be deallocated, and must be - free3d + free3d by the caller if necessary. @@ -343,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 @@ -351,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. @@ -376,7 +376,7 @@ along with systemd; If not, see . - -EINVAL + -EINVAL Error was already set in sd_bus_error structure when one the @@ -384,7 +384,7 @@ along with systemd; If not, see . - -ENOMEM + -ENOMEM Memory allocation failed. @@ -397,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 pkg-config1 + libsystemd pkg-config1 file. @@ -407,7 +407,7 @@ along with systemd; If not, see . systemd1, sd-bus3, - errno3, + errno3, strerror3