uuid(), uuid_compare(), uuid_create(), uuid_create_nil(), uuid_equal(), uuid_from_string(), uuid_hash(), uuid_is_nil(), uuid_to_string()

DCE 1.1 compliant UUID functions 

Function


SYNOPSIS

#include <uuid.h>

int32_t uuid_compare(const uuid_t *uuid1, const uuid_t *uuid2, uint32_t *status);

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

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

int32_t uuid_equal(const uuid_t *uuid1, const uuid_t *uuid2, uint32_t *status);

void uuid_from_string(const char *str, uuid_t *uuid, uint32_t *status);

uint16_t uuid_hash(const uuid_t *uuid, uint32_t *status);

int32_t uuid_is_nil(const uuid_t *uuid, uint32_t *status);

void uuid_to_string(const uuid_t *uuid, char **str, uint32_t *status);

void uuid_enc_le(void *buf, const uuid_t *uuid);

void uuid_dec_le(const void *buf, uuid_t *);

void uuid_enc_be(void *buf, const uuid_t *uuid);

void uuid_dec_be(const void *buf, uuid_t *);


DESCRIPTION

The family of DCE 1.1 compliant UUID functions allow applications to operate on universally unique identifiers, or UUIDs.

The uuid_create() and uuid_create_nil() functions create UUIDs. The uuid_compare(), uuid_equal() and uuid_is_nil() functions can be used to test UUIDs. To convert from the binary representation to the string representation or vice versa, use uuid_to_string() or uuid_from_string() respectively. A 16-bit hash value can be obtained by calling uuid_hash().

The uuid_enc_le() and uuid_enc_be() functions encode a binary representation of a UUID into an octet stream in little-endian and big-endian byte-order, respectively. The destination buffer must be pre-allocated by the caller, and must be large enough to hold the 16-octet binary UUID. These routines are not part of the DCE RPC API. They are provided for convenience.

The uuid_dec_le() and uuid_dec_be() functions decode a UUID from an octet stream in little-endian and big-endian byte-order, respectively. These routines are not part of the DCE RPC API. They are provided for convenience.


RETURN VALUES

The successful or unsuccessful completion of the function is returned in the status argument. Possible values are:

uuid_s_ok The function completed successfully. uuid_s_bad_version The UUID does not have a known version. uuid_s_invalid_string_uuid The string representation of an UUID is not valid. uuid_s_no_memory The meaning of the code escaped the writers mind.


CONFORMANCE

The UUID functions conform to the DCE 1.1 RPC specification.


MULTITHREAD SAFETY LEVEL

Safe.


PORTING ISSUES

Linux versions of these functions require the inclusion of <uuid/uuid.h> and -luuid (libuuid) on the link line. The PTC MKS Toolkit versions are based on BSD UNIX source and are directly in libc.


PORTABILITY

FreeBSD 5 and up. Windows Server 2012. Windows 8.1. Windows Server 2012 R2. Windows 10. Windows Server 2016. Windows Server 2019.


AVAILABILITY

PTC MKS Toolkit for Professional Developers
PTC MKS Toolkit for Professional Developers 64-Bit Edition
PTC MKS Toolkit for Enterprise Developers
PTC MKS Toolkit for Enterprise Developers 64-Bit Edition


SEE ALSO

Commands:
uuidgen

Functions:
uuidgen()


PTC MKS Toolkit 10.3 Documentation Build 39.