UUID(3C)							      UUID(3C)

NAME    [Toc]    [Back]

     uuid_create, uuid_create_nil, uuid_compare, uuid_equal, uuid_is_nil,
     uuid_hash,	uuid_from_string, uuid_to_string - Universal Unique Identifier
     functions

SYNOPSIS    [Toc]    [Back]

     #include <sys/types.h>
     #include <sys/uuid.h>

     void uuid_create (uuid_t *uuid, uint_t *status);

     void uuid_create_nil (uuid_t *uuid, uint_t	*status);

     boolean_t uuid_is_nil (uuid_t *uuid, uint_t *status);

     boolean_t uuid_equal (uuid_t *uuid1, uuid_t *uuid2, uint_t	*status);

     int uuid_compare (uuid_t *uuid1, uuid_t *uuid2, uint_t *status);

     void uuid_to_string (uuid_t *uuid,	char **uuid_str, uint_t	*status);

     void uuid_from_string (char *uuid_str, uuid_t *uuid, uint_t *status);

     ushort_t uuid_hash	(uuid_t	*uuid, uint_t *status);

DESCRIPTION    [Toc]    [Back]

     Universal Unique Identifiers are bit strings that may be generated
     independently on separate nodes (hosts) such that globally	unique strings
     result without requiring the hosts	to be in communication with each other
     to	ensure uniqueness.  They are a component of DCE	that have been
     independently reimplemented in IRIX, but is in accordance with the	DCE
     specification.  This implementation is API	compatible with	the DCE
     implementation.

     The status	parameter in all functions is set to uuid_s_ok if the
     functions succeeds, and does not equal uuid_s_ok if the function fails.
     A description of each function follows.

     uuid_create creates a new UUID.

     uuid_create_nil creates a specially-defined UUID, the nil UUID.  The nil
     UUID may be used to initialize/clear UUID structures.

     uuid_compare defines an ordering relationship between UUIDs.  It returns
     -1, 0, or 1 as determined by the relative order of	the argument UUIDs.
     The nil UUID precedes all others in order.	 The return values of -1, 0,
     and 1 are generated respectively as uuid1 precedes, is equal to, or
     follows uuid2.

     uuid_equal	tests two UUIDs	for equality.  It returns B_TRUE if the	UUIDs
     are equal,	and B_FALSE if they are	not.




									Page 1






UUID(3C)							      UUID(3C)



     uuid_is_nil tests a UUID for equality with	the nil	UUID.  It returns
     B_TRUE if the UUID	is a nil UUID, and B_FALSE if it is not.

     uuid_hash returns a hash value for	a UUID.

     uuid_from_string converts a string	representation of a UUID into its
     binary form.

     uuid_to_string converts a binary UUID into	its string representation.
     Storage for the string is obtained	using malloc(3c), and thus should be
     returned using free(3c).

SEE ALSO    [Toc]    [Back]

     malloc(3c), free(3c)

DIAGNOSTICS    [Toc]    [Back]

     Return values are described in the	description of each (non-void)
     function.	The status parameter serves the	purpose	usually	fulfilled by
     the return	value.	See above for a	description of status.

NOTES    [Toc]    [Back]

     The DCE version and this version of uuid_compare may return different
     results for the same UUIDs.  The same is true for the values returned by
     each version of uuid_hash.


									PPPPaaaaggggeeee 2222