manual/util-linux/original/man3/uuid_parse.3

   1 '\" t
   2 .\"     Title: uuid_parse
   3 .\"    Author: [see the "AUTHOR(S)" section]
   4 .\" Generator: Asciidoctor 2.0.15
   5 .\"      Date: 2022-01-06
   6 .\"    Manual: Programmer's Manual
   7 .\"    Source: util-linux 2.37.4
   8 .\"  Language: English
   9 .\"
  10 .TH "UUID_PARSE" "3" "2022-01-06" "util\-linux 2.37.4" "Programmer\(aqs Manual"
  11 .ie \n(.g .ds Aq \(aq
  12 .el       .ds Aq '
  13 .ss \n[.ss] 0
  14 .nh
  15 .ad l
  16 .de URL
  17 \fI\\$2\fP <\\$1>\\$3
  18 ..
  19 .als MTO URL
  20 .if \n[.g] \{\
  21 .  mso www.tmac
  22 .  am URL
  23 .    ad l
  24 .  .
  25 .  am MTO
  26 .    ad l
  27 .  .
  28 .  LINKSTYLE blue R < >
  29 .\}
  30 .SH "NAME"
  31 uuid_parse \- convert an input UUID string into binary representation
  32 .SH "SYNOPSIS"
  33 .sp
  34 \fB#include <uuid.h>\fP
  35 .sp
  36 \fBint uuid_parse(char *\fIin\fP, uuid_t \fIuu\fP);\fP
  37 .br
  38 \fBint uuid_parse_range(char *\fIin_start\fP, char *\fIin_end\fP, uuid_t \fIuu\fP);\fP
  39 .SH "DESCRIPTION"
  40 .sp
  41 The \fBuuid_parse\fP() function converts the UUID string given by \fIin\fP into the binary representation. The input UUID is a string of the form 1b4e28ba\-2fa1\-11d2\-883f\-b9a761bde3fb (in \fBprintf\fP(3) format "%08x\-%04x\-%04x\-%04x\-%012x", 36 bytes plus the trailing \(aq\(rs0\(aq).
  42 .sp
  43 The \fBuuid_parse_range\fP() function works like \fBuuid_parse\fP() but parses only range in string specified by \fIin_start\fP and \fIin_end\fP pointers.
  44 .SH "RETURN VALUE"
  45 .sp
  46 Upon successfully parsing the input string, 0 is returned, and the UUID is stored in the location pointed to by \fIuu\fP, otherwise \-1 is returned.
  47 .SH "CONFORMING TO"
  48 .sp
  49 This library parses UUIDs compatible with OSF DCE 1.1, and hash based UUIDs V3 and V5 compatible with \c
  50 .URL "https://tools.ietf.org/html/rfc4122" "RFC\-4122" "."
  51 .SH "AUTHORS"
  52 .sp
  53 Theodore Y. Ts\(cqo
  54 .SH "SEE ALSO"
  55 .sp
  56 \fBuuid\fP(3),
  57 \fBuuid_clear\fP(3),
  58 \fBuuid_compare\fP(3),
  59 \fBuuid_copy\fP(3),
  60 \fBuuid_generate\fP(3),
  61 \fBuuid_is_null\fP(3),
  62 \fBuuid_time\fP(3),
  63 \fBuuid_unparse\fP(3)
  64 .SH "REPORTING BUGS"
  65 .sp
  66 For bug reports, use the issue tracker at \c
  67 .URL "https://github.com/karelzak/util\-linux/issues" "" "."
  68 .SH "AVAILABILITY"
  69 .sp
  70 The \fBlibuuid\fP library is part of the util\-linux package since version 2.15.1. It can be downloaded from \c
  71 .URL "https://www.kernel.org/pub/linux/utils/util\-linux/" "Linux Kernel Archive" "."