summaryrefslogtreecommitdiff
path: root/man/sd_id128_to_string.xml
diff options
context:
space:
mode:
authorLennart Poettering <lennart@poettering.net>2016-07-21 20:23:51 +0200
committerLennart Poettering <lennart@poettering.net>2016-07-22 12:59:36 +0200
commit9ca8d43479dc198e8d6fc86492aa6576f97bbfc2 (patch)
tree5f89f1d15bc4016d7014aff71306af38cee6d938 /man/sd_id128_to_string.xml
parente042eab7200b0c96c19f80100e3624bdba653a92 (diff)
downloadsystemd-9ca8d43479dc198e8d6fc86492aa6576f97bbfc2.tar.gz
sd-id128: handle NULL return parameter in sd_id128_from_string() nicer
If the return parameter is NULL, simply validate the string, and return no error.
Diffstat (limited to 'man/sd_id128_to_string.xml')
-rw-r--r--man/sd_id128_to_string.xml12
1 files changed, 5 insertions, 7 deletions
diff --git a/man/sd_id128_to_string.xml b/man/sd_id128_to_string.xml
index e70c80892e..927d1ad5f2 100644
--- a/man/sd_id128_to_string.xml
+++ b/man/sd_id128_to_string.xml
@@ -74,13 +74,11 @@
lowercase hexadecimal digits and be terminated by a
<constant>NUL</constant> byte.</para>
- <para><function>sd_id128_from_string()</function> implements the
- reverse operation: it takes a 33 character string with 32
- hexadecimal digits (either lowercase or uppercase, terminated by
- <constant>NUL</constant>) and parses them back into a 128-bit ID
- returned in <parameter>ret</parameter>. Alternatively, this call
- can also parse a 37-character string with a 128-bit ID formatted
- as RFC UUID.</para>
+ <para><function>sd_id128_from_string()</function> implements the reverse operation: it takes a 33 character string
+ with 32 hexadecimal digits (either lowercase or uppercase, terminated by <constant>NUL</constant>) and parses them
+ back into a 128-bit ID returned in <parameter>ret</parameter>. Alternatively, this call can also parse a
+ 37-character string with a 128-bit ID formatted as RFC UUID. If <parameter>ret</parameter> is passed as NULL the
+ function will validate the passed ID string, but not actually return it in parsed form.</para>
<para>For more information about the <literal>sd_id128_t</literal>
type see