FUID Class Reference
[Basic Interfaces]

Handling 16 Byte Globaly Unique Identifiers. More...

#include <funknown.h>

Public Types

enum  UIDPrintStyle { kINLINE_UID, kDECLARE_UID, kFUID, kCLASS_UID }
typedef char8 String [64]

Public Member Functions

 FUID ()
 FUID (const TUID uid)
 FUID (uint32 l1, uint32 l2, uint32 l3, uint32 l4)
 FUID (const FUID &)
virtual ~FUID ()
bool generate ()
 Generates a new Unique Identifier (UID).
bool isValid () const
 Checks if the UID data is valid.
FUIDoperator= (const FUID &f)
FUIDoperator= (FIDString uid)
FUIDoperator= (TUID uid)
bool operator== (const FUID &f) const
bool operator== (FIDString uid) const
bool operator== (TUID uid) const
bool operator< (const FUID &f) const
bool operator< (FIDString uid) const
bool operator< (TUID uid) const
bool operator!= (const FUID &f) const
bool operator!= (FIDString uid) const
bool operator!= (TUID uid) const
 operator FIDString () const
 operator char * ()
uint32 getLong1 () const
uint32 getLong2 () const
uint32 getLong3 () const
uint32 getLong4 () const
void from4Int (uint32 d1, uint32 d2, uint32 d3, uint32 d4)
void to4Int (uint32 &d1, uint32 &d2, uint32 &d3, uint32 &d4) const
void toString (char8 *string) const
 Converts UID to a string.
bool fromString (const char8 *string)
 Sets the UID data from a string.
void toRegistryString (char8 *string) const
 Converts UID to a string in Microsoft® OLE format.
bool fromRegistryString (const char8 *string)
 Sets the UID data from a string in Microsoft® OLE format.
void print (char8 *string=0, int32 style=kINLINE_UID) const
 Prints the UID to a string (or debug output if string is NULL).
void toTUID (TUID result) const

Protected Attributes

TUID data

Detailed Description

Handling 16 Byte Globaly Unique Identifiers.

Each interface declares its identifier as static member inside the interface namespace (e.g. FUnknown::iid).


Member Typedef Documentation

typedef char8 String[64]

Member Enumeration Documentation

Enumerator:
kINLINE_UID 

"INLINE_UID (0x00000000, 0x00000000, 0x00000000, 0x00000000)"

kDECLARE_UID 

"DECLARE_UID (0x00000000, 0x00000000, 0x00000000, 0x00000000)"

kFUID 

"FUID (0x00000000, 0x00000000, 0x00000000, 0x00000000)"

kCLASS_UID 

"DECLARE_CLASS_IID (Interface, 0x00000000, 0x00000000, 0x00000000, 0x00000000)"


Constructor & Destructor Documentation

FUID (  ) 
FUID ( const TUID  uid  ) 
FUID ( uint32  l1,
uint32  l2,
uint32  l3,
uint32  l4 
)
FUID ( const FUID f  ) 
~FUID (  )  [virtual]

Member Function Documentation

bool generate (  ) 

Generates a new Unique Identifier (UID).

Will return true for success. If the return value is false, either no UID is generated or the UID is not guaranteed to be unique worldwide.

bool isValid (  )  const

Checks if the UID data is valid.

The default constructor initializes the memory with zeros.

FUID & operator= ( const FUID f  ) 
FUID & operator= ( FIDString  uid  ) 
FUID & operator= ( TUID  uid  ) 
bool operator== ( const FUID f  )  const [inline]
bool operator== ( FIDString  uid  )  const [inline]
bool operator== ( TUID  uid  )  const [inline]
bool operator< ( const FUID f  )  const [inline]
bool operator< ( FIDString  uid  )  const [inline]
bool operator< ( TUID  uid  )  const [inline]
bool operator!= ( const FUID f  )  const [inline]
bool operator!= ( FIDString  uid  )  const [inline]
bool operator!= ( TUID  uid  )  const [inline]
operator FIDString (  )  const [inline]
operator char * (  )  [inline]
uint32 getLong1 (  )  const
uint32 getLong2 (  )  const
uint32 getLong3 (  )  const
uint32 getLong4 (  )  const
void from4Int ( uint32  d1,
uint32  d2,
uint32  d3,
uint32  d4 
)
void to4Int ( uint32 d1,
uint32 d2,
uint32 d3,
uint32 d4 
) const
void toString ( char8 string  )  const

Converts UID to a string.

The string will be 32 characters long, representing the hexadecimal values of each data byte (e.g. "9127BE30160E4BB69966670AA6087880").

bool fromString ( const char8 string  ) 

Sets the UID data from a string.

The string has to be 32 characters long, where each character-pair is the ASCII-encoded hexadecimal value of the corresponding data byte.

void toRegistryString ( char8 string  )  const

Converts UID to a string in Microsoft® OLE format.

(e.g. "{c200e360-38c5-11ce-ae62-08002b2b79ef}")

bool fromRegistryString ( const char8 string  ) 

Sets the UID data from a string in Microsoft® OLE format.

void print ( char8 string = 0,
int32  style = kINLINE_UID 
) const

Prints the UID to a string (or debug output if string is NULL).

Parameters:
string is the output string if not NULL.
style can be chosen from the FUID::UIDPrintStyle enumeration.
void toTUID ( TUID  result  )  const

Field Documentation

TUID data [protected]
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Defines
Empty

Copyright ©2013 Steinberg Media Technologies GmbH. All Rights Reserved.