lib/uuid/uuid_parse.3.in

   1 .\" Copyright 1999 Andreas Dilger (adilger@enel.ucalgary.ca)
   2 .\"
   3 .\" This man page was created for libuuid.so.1.1 from e2fsprogs-1.14.
   4 .\"
   5 .\" This file may be copied under the terms of the GNU Public License.
   6 .\"
   7 .\" Created  Wed Mar 10 17:42:12 1999, Andreas Dilger
   8 .TH UUID_PARSE 3 "@E2FSPROGS_MONTH@ @E2FSPROGS_YEAR@" "E2fsprogs version @E2FSPROGS_VERSION@"
   9 .SH NAME
  10 uuid_parse \- convert an input UUID string into the libuuid internal format
  11 .SH SYNOPSIS
  12 .nf
  13 .B #include <uuid/uuid.h>
  14 .sp
  15 .BI "int uuid_parse( char *" in ", uuid_t " uu );
  16 .fi
  17 .SH DESCRIPTION
  18 The
  19 .B uuid_parse
  20 function converts the UUID string given by
  21 .I in
  22 into the internal
  23 .B uuid_t
  24 format.  The input UUID is a string of the form
  25 1b4e28ba\-2fa1\-11d2\-883f\-b9a761bde3fb (in
  26 .BR printf (3)
  27 format "%08x\-%04x\-%04x\-%04x\-%012x", 36 bytes plus the trailing '\\0').
  28 .SH RETURN VALUE
  29 Upon successfully parsing the input string, 0 is returned, and the UUID is
  30 stored in the location pointed to by
  31 .IR uu ,
  32 otherwise \-1 is returned.
  33 .SH "CONFORMING TO"
  34 OSF DCE 1.1
  35 .SH AUTHOR
  36 .B uuid_parse
  37 was written by Theodore Y. Ts'o for the ext2 filesystem utilties.
  38 .SH AVAILABILITY
  39 .B uuid_parse
  40 is part of libuuid from the e2fsprogs package and is available for anonymous
  41 ftp from tsx\-11.mit.edu (and its mirrors) in /pub/linux/packages/ext2fs.
  42 .SH "SEE ALSO"
  43 .BR libuuid (3),
  44 .BR uuid_clear (3),
  45 .BR uuid_compare (3),
  46 .BR uuid_copy (3),
  47 .BR uuid_generate (3),
  48 .BR uuid_is_null (3),
  49 .BR uuid_time (3),
  50 .BR uuid_unparse (3)