X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?a=blobdiff_plain;f=man%2Fsd_id128_to_string.xml;h=71cf82a6cdbfc70598a60bc2672e8a026fce8d66;hb=12179984a38fe74581333fbcdc11c822d81f505f;hp=eda35b08b1675360c43dce2d7f38886b78b94752;hpb=cb07866b1b7c11e687a322d70dd9f9d73bbbe488;p=elogind.git
diff --git a/man/sd_id128_to_string.xml b/man/sd_id128_to_string.xml
index eda35b08b..71cf82a6c 100644
--- a/man/sd_id128_to_string.xml
+++ b/man/sd_id128_to_string.xml
@@ -45,7 +45,7 @@
sd_id128_to_string
sd_id128_from_string
- Format or parse 128 bit IDs as strings
+ Format or parse 128-bit IDs as strings
@@ -59,7 +59,7 @@
int sd_id128_from_string
- const char s[33], sd_id128_t* ret
+ const char* s, sd_id128_t* ret
@@ -69,27 +69,33 @@
Description
sd_id128_to_string()
- formats a 128 bit ID as character string. It expects
+ formats a 128-bit ID as a character string. It expects
the ID and a string array capable of storing 33
characters. The ID will be formatted as 32 lowercase
- hexadecimal digits and be terminated by a NUL
- byte.
+ hexadecimal digits and be terminated by a
+ NUL byte.
sd_id128_from_string()
implements the reverse operation: it takes a 33
- character array with 32 hexadecimial digits
- (terminated by NUL) and parses them back into an
- 128 bit ID returned in
- ret.
+ character string with 32 hexadecimal digits (either
+ lowercase or uppercase, terminated by
+ NUL) and parses them back into a
+ 128-bit ID returned in
+ ret. Alternatively, this call
+ can also parse a 37-character string with a 128-bit ID
+ formatted as RFC UUID.
For more information about the
sd_id128_t type see
- sd-id1283.
+ sd-id1283. Note
+ that these calls operate the same way on all
+ architectures, i.e. the results do not depend on
+ endianness.
- When formatting a 128 bit ID into a string it is
+ When formatting a 128-bit ID into a string, it is
often easier to use a format string for
printf3. This
- is easly done using the
+ is easily done using the
SD_ID128_FORMAT_STR and
SD_ID128_FORMAT_VAL() macros. For
more information see
@@ -101,9 +107,9 @@
sd_id128_to_string() always
succeeds and returns a pointer to the string array
- passed in. sd_id128_from_string
- returns 0 on success (in which case
- ret is filled in), or a negative
+ passed in. sd_id128_from_string
+ returns 0 on success, in which case
+ ret is filled in, or a negative
errno-style error code.
@@ -113,8 +119,7 @@
The sd_id128_to_string()
and sd_id128_from_string() interfaces are
available as shared library, which can be compiled and
- linked to with the libsystemd-id128
- pkg-config1
+ linked to with the libsystemd-id128Â pkg-config1
file.