From 12355095821fc17529af5b6eaefa31c3c520be39 Mon Sep 17 00:00:00 2001 From: Lennart Poettering Date: Fri, 6 Jul 2012 17:50:00 +0200 Subject: man: document libsystemd-id128 --- man/sd_id128_to_string.xml | 131 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 131 insertions(+) create mode 100644 man/sd_id128_to_string.xml (limited to 'man/sd_id128_to_string.xml') diff --git a/man/sd_id128_to_string.xml b/man/sd_id128_to_string.xml new file mode 100644 index 0000000000..3a171550e9 --- /dev/null +++ b/man/sd_id128_to_string.xml @@ -0,0 +1,131 @@ + + + + + + + + + sd_id128_to_string + systemd + + + + Developer + Lennart + Poettering + lennart@poettering.net + + + + + + sd_id128_to_string + 3 + + + + sd_id128_to_string + sd_id128_from_string + Format or parse 128 bit IDs as strings + + + + + #include <systemd/sd-id128.h> + + + char* sd_id128_to_string + sd_id128_t id, char s[33] + + + + int sd_id128_from_string + const char s[33], sd_id128_t* ret + + + + + + + Description + + sd_id128_to_string() + formats a 128 bit ID as 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. + + 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. + + For more information about the + sd_id128_t type see + sd-id1287. + + 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 + SD_ID128_FORMAT_STR and + SD_ID128_FORMAT_VAL() macros. For + more information see + sd-id1287. + + + + Return Value + + 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 + errno-style error code. + + + + Notes + + 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 + file. + + + + See Also + + + systemd1, + sd-id1287, + printf3 + + + + -- cgit v1.2.3-54-g00ecf