LayerAS_Layer
ObjectASUUID

An object containing data and methods supporting a universal unique identifier (UUID) for the current user or the current session.



Define Summary
 Define
 ASUUIDMaxStringLen
A constant for the maximum string length of a unique identifier (UUID).
Structure Summary
 Structure
 ASUUID
A structure representing a universal unique identifier (UUID) for the current user or the current session.
Method Summary
 Method
 
ASBool ASUUIDFromCString(ASUUID* dst, const char* str)
Parses a C string, such as one generated by ASUUIDToCString(), into a unique identifier (UUID).
 
ASBool ASUUIDGenFromHash(ASUUID* dst, ASUns8 hash)
Generates a unique identifier (UUID) from a hash value.
 
ASBool ASUUIDGenFromName(ASUUID* dst, const ASUUID* ns, void* name, ASByteCount bytes)
Generates a universal unique identifier (UUID) for a block of data (a name) in a context (a namespace).
 
ASBool ASUUIDGenUnique(ASUUID* dst)
Generates a unique identifier (UUID).
 
void ASUUIDToCString(char* dst, const ASUUID* src)
Generates a NULL-terminated C string from the unique identifier (UUID) for a user or session.
Defines Detail
ASUUIDMaxStringLen 
Product availability: All
Platform availability: All

Syntax

#define ASUUIDMaxStringLen 40

Description

A constant for the maximum string length of a unique identifier (UUID).

See Also


File: ASExpT.h
Line: 4001



Structure Detail
ASUUID
Product availability: All
Platform availability: All

Syntax

struct ASUUID {
 ASUns32 timeLow; 
 
 ASUns16 timeMid; 
 
 ASUns16 timeHiAndVersion; 
 
 ASUns8 clockSeqHiAndReserved; 
 
 ASUns8 clockSeqLow; 
 
 ASUns8 node[6]; 
}

A structure representing a universal unique identifier (UUID) for the current user or the current session.


File: ASExpT.h
Line: 3981

Elements
timeLow  

Timestamp low field.

 
timeMid  

Timestamp middle field.

 
timeHiAndVersion  

Timestamp middle field multiplexed with the version number.

 
clockSeqHiAndReserved  

High field of the clock sequence multiplexed with the variant.

 
clockSeqLow  

Low field of the clock sequence.

 
node  

The spatially unique node identifier.


Method Detail
ASUUIDFromCString()
Product availability: All
Platform availability: All

Syntax

ASBool ASUUIDFromCString(ASUUID* dst, const char* str)

Parses a C string, such as one generated by ASUUIDToCString(), into a unique identifier (UUID).

Parameters

dst — 

(Filled by the method) The UUID created from the string.

 
str — 

A NULL-terminated string from which to generate the UUID, in the following form: f81d4fae-7dec-11d0-a765-00a0c91e6bf6.

Returns

true if the UUID is successfully created, false otherwise.

See Also

Since

PI_ASEXTRA_VERSION >= 0x00060000

File: ASProcs.h
Line: 2190
ASUUIDGenFromHash() 
Product availability: All
Platform availability: All

Syntax

ASBool ASUUIDGenFromHash(ASUUID* dst, ASUns8 hash)

Generates a unique identifier (UUID) from a hash value.

Parameters

dst — 

(Filled by the method) The UUID created from the hash.

 
hash — 

A hash value, such as MD5.

Returns

true if the UUID is successfully created, false otherwise.

See Also

Since

PI_ASEXTRA_VERSION >= 0x00060000

File: ASProcs.h
Line: 2173
ASUUIDGenFromName() 
Product availability: All
Platform availability: All

Syntax

ASBool ASUUIDGenFromName(ASUUID* dst, const ASUUID* ns, void* name, ASByteCount bytes)

Generates a universal unique identifier (UUID) for a block of data (a name) in a context (a namespace).

Parameters

dst — 

(Filled by the method) The UUID created from the name.

 
ns — 

A namespace or context meaningful to the client.

 
name — 

A pointer to an arbitrary block of data to be identified by the UUID.

 
bytes — 

The number of bytes in name.

Returns

true if the UUID is successfully created, false otherwise.

See Also

Since

PI_ASEXTRA_VERSION >= 0x00060000

File: ASProcs.h
Line: 2157
ASUUIDGenUnique() 
Product availability: All
Platform availability: All

Syntax

ASBool ASUUIDGenUnique(ASUUID* dst)

Generates a unique identifier (UUID).

Parameters

dst — 

(Filled by the method) The UUID created from the hash.

Returns

true if the UUID is successfully created, false otherwise.

See Also

Since

PI_ASEXTRA_VERSION >= 0x00060000

File: ASProcs.h
Line: 2137
ASUUIDToCString() 
Product availability: All
Platform availability: All

Syntax

void ASUUIDToCString(char* dst, const ASUUID* src)

Generates a NULL-terminated C string from the unique identifier (UUID) for a user or session.

Parameters

dst — 

(Filled by the method) A NULL-terminated string from which to generate the UUID, in the following form: f81d4fae-7dec-11d0-a765-00a0c91e6bf6. The string must be at least the length specified by ASUUIDMaxStringLen().

 
src — 

The UUID from which to generate the string .

See Also

Since

PI_ASEXTRA_VERSION >= 0x00060000

File: ASProcs.h
Line: 2208