man/sd_id128_to_string.xml

   1 <?xml version='1.0'?> <!--*-nxml-*-->
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
   3         "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
   4
   5 <!--
   6   This file is part of systemd.
   7
   8   Copyright 2012 Lennart Poettering
   9
  10   systemd is free software; you can redistribute it and/or modify it
  11   under the terms of the GNU Lesser General Public License as published by
  12   the Free Software Foundation; either version 2.1 of the License, or
  13   (at your option) any later version.
  14
  15   systemd is distributed in the hope that it will be useful, but
  16   WITHOUT ANY WARRANTY; without even the implied warranty of
  17   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  18   Lesser General Public License for more details.
  19
  20   You should have received a copy of the GNU Lesser General Public License
  21   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  22 -->
  23
  24 <refentry id="sd_id128_to_string">
  25
  26         <refentryinfo>
  27                 <title>sd_id128_to_string</title>
  28                 <productname>systemd</productname>
  29
  30                 <authorgroup>
  31                         <author>
  32                                 <contrib>Developer</contrib>
  33                                 <firstname>Lennart</firstname>
  34                                 <surname>Poettering</surname>
  35                                 <email>lennart@poettering.net</email>
  36                         </author>
  37                 </authorgroup>
  38         </refentryinfo>
  39
  40         <refmeta>
  41                 <refentrytitle>sd_id128_to_string</refentrytitle>
  42                 <manvolnum>3</manvolnum>
  43         </refmeta>
  44
  45         <refnamediv>
  46                 <refname>sd_id128_to_string</refname>
  47                 <refname>sd_id128_from_string</refname>
  48                 <refpurpose>Format or parse 128 bit IDs as strings</refpurpose>
  49         </refnamediv>
  50
  51         <refsynopsisdiv>
  52                 <funcsynopsis>
  53                         <funcsynopsisinfo>#include &lt;systemd/sd-id128.h&gt;</funcsynopsisinfo>
  54
  55                         <funcprototype>
  56                                 <funcdef>char* <function>sd_id128_to_string</function></funcdef>
  57                                 <paramdef>sd_id128_t <parameter>id</parameter>, char <parameter>s</parameter>[33]</paramdef>
  58                         </funcprototype>
  59
  60                         <funcprototype>
  61                                 <funcdef>int <function>sd_id128_from_string</function></funcdef>
  62                                 <paramdef>const char <parameter>s</parameter>[33], sd_id128_t* <parameter>ret</parameter></paramdef>
  63                         </funcprototype>
  64
  65                 </funcsynopsis>
  66         </refsynopsisdiv>
  67
  68         <refsect1>
  69                 <title>Description</title>
  70
  71                 <para><function>sd_id128_to_string()</function>
  72                 formats a 128 bit ID as character string. It expects
  73                 the ID and a string array capable of storing 33
  74                 characters. The ID will be formatted as 32 lowercase
  75                 hexadecimal digits and be terminated by a NUL
  76                 byte.</para>
  77
  78                 <para><function>sd_id128_from_string()</function>
  79                 implements the reverse operation: it takes a 33
  80                 character array with 32 hexadecimial digits
  81                 (terminated by NUL) and parses them back into an
  82                 128 bit ID returned in
  83                 <parameter>ret</parameter>.</para>
  84
  85                 <para>For more information about the
  86                 <literal>sd_id128_t</literal> type see
  87                 <citerefentry><refentrytitle>sd-id128</refentrytitle><manvolnum>3</manvolnum></citerefentry>.</para>
  88
  89                 <para>When formatting a 128 bit ID into a string it is
  90                 often easier to use a format string for
  91                 <citerefentry><refentrytitle>printf</refentrytitle><manvolnum>3</manvolnum></citerefentry>. This
  92                 is easly done using the
  93                 <function>SD_ID128_FORMAT_STR</function> and
  94                 <function>SD_ID128_FORMAT_VAL()</function> macros. For
  95                 more information see
  96                 <citerefentry><refentrytitle>sd-id128</refentrytitle><manvolnum>3</manvolnum></citerefentry>.</para>
  97         </refsect1>
  98
  99         <refsect1>
 100                 <title>Return Value</title>
 101
 102                 <para><function>sd_id128_to_string()</function> always
 103                 succeeds and returns a pointer to the string array
 104                 passed in.  <function>sd_id128_from_string</function>
 105                 returns 0 on success (in which case
 106                 <parameter>ret</parameter> is filled in), or a negative
 107                 errno-style error code.</para>
 108         </refsect1>
 109
 110         <refsect1>
 111                 <title>Notes</title>
 112
 113                 <para>The <function>sd_id128_to_string()</function>
 114                 and <function>sd_id128_from_string()</function> interfaces are
 115                 available as shared library, which can be compiled and
 116                 linked to with the <literal>libsystemd-id128</literal>
 117                 <citerefentry><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry>
 118                 file.</para>
 119         </refsect1>
 120
 121         <refsect1>
 122                 <title>See Also</title>
 123
 124                 <para>
 125                         <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 126                         <citerefentry><refentrytitle>sd-id128</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
 127                         <citerefentry><refentrytitle>printf</refentrytitle><manvolnum>3</manvolnum></citerefentry>
 128                 </para>
 129         </refsect1>
 130
 131 </refentry>