Steinberg::FUID Class Reference

Handling 16 Byte Globally Unique Identifiers. More...

#include "funknown.h"

Public Types
enum	UIDPrintStyle { kINLINE_UID , kDECLARE_UID , kFUID , kCLASS_UID }
typedef char8	String[33]

Public Member Functions
	FUID (uint32 l1, uint32 l2, uint32 l3, uint32 l4)
	FUID (const FUID &)
bool	generate ()
	Generates a new Unique Identifier (UID).
bool	isValid () const
	Checks if the UID data is valid.
FUID &	operator= (const FUID &f)
bool	operator== (const FUID &f) const
bool	operator< (const FUID &f) const
bool	operator!= (const FUID &f) const
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(R) OLE format.
bool	fromRegistryString (const char8 *string)
	Sets the UID data from a string in Microsoft(R) OLE format.
void	print (int32 style, char8 *string=nullptr, size_t stringBufferSize=0) const
	Prints the UID to a string (or debug output if string is NULL).
void	print (char8 *string=nullptr, int32 style=kINLINE_UID) const
template<size_t N>
	FUID (const char(&uid)[N])
void	toTUID (TUID result) const
	operator const TUID & () const
const TUID &	toTUID () const

Static Public Member Functions
static FUID	fromTUID (const TUID uid)

Protected Attributes
TUID	data

Detailed Description

Handling 16 Byte Globally Unique Identifiers.

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

Definition at line 240 of file funknown.h.

Member Typedef Documentation

String

typedef char8 Steinberg::FUID::String[33]

Definition at line 276 of file funknown.h.

Member Enumeration Documentation

UIDPrintStyle

enum Steinberg::FUID::UIDPrintStyle

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)"

Definition at line 304 of file funknown.h.

Constructor & Destructor Documentation

FUID() [1/4]

Steinberg::FUID::FUID

(

)

Definition at line 119 of file funknown.cpp.

FUID() [2/4]

Steinberg::FUID::FUID	(	uint32	l1,
		uint32	l2,
		uint32	l3,
		uint32	l4
	)

Definition at line 125 of file funknown.cpp.

FUID() [3/4]

Steinberg::FUID::FUID

(

const FUID &

f

)

Definition at line 131 of file funknown.cpp.

~FUID()

virtual Steinberg::FUID::~FUID ( )

virtual

Definition at line 247 of file funknown.h.

FUID() [4/4]

template<size_t N>

Steinberg::FUID::FUID ( const char(&)  uid[N] )

explicit

Definition at line 323 of file funknown.h.

Member Function Documentation

from4Int()

void Steinberg::FUID::from4Int	(	uint32	d1,
		uint32	d2,
		uint32	d3,
		uint32	d4
	)

Definition at line 207 of file funknown.cpp.

fromRegistryString()

bool Steinberg::FUID::fromRegistryString

(

const char8 *

string

)

Sets the UID data from a string in Microsoft(R) OLE format.

Definition at line 345 of file funknown.cpp.

fromString()

bool Steinberg::FUID::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.

Definition at line 314 of file funknown.cpp.

fromTUID()

static FUID Steinberg::FUID::fromTUID ( const TUID  uid )

static

Definition at line 334 of file funknown.h.

generate()

bool Steinberg::FUID::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.

Definition at line 151 of file funknown.cpp.

getLong1()

uint32 Steinberg::FUID::getLong1

(

)

const

Definition at line 256 of file funknown.cpp.

getLong2()

uint32 Steinberg::FUID::getLong2

(

)

const

Definition at line 266 of file funknown.cpp.

getLong3()

uint32 Steinberg::FUID::getLong3

(

)

const

Definition at line 276 of file funknown.cpp.

getLong4()

uint32 Steinberg::FUID::getLong4

(

)

const

Definition at line 286 of file funknown.cpp.

isValid()

bool Steinberg::FUID::isValid

(

)

const

Checks if the UID data is valid.

The default constructor initializes the memory with zeros.

Definition at line 192 of file funknown.cpp.

operator const TUID &()

Steinberg::FUID::operator const TUID &

(

)

const

Definition at line 331 of file funknown.h.

operator!=()

bool Steinberg::FUID::operator!=

(

const FUID &

f

)

const

Definition at line 266 of file funknown.h.

operator<()

bool Steinberg::FUID::operator<

(

const FUID &

f

)

const

Definition at line 265 of file funknown.h.

operator=()

FUID & Steinberg::FUID::operator=

(

const FUID &

f

)

Definition at line 200 of file funknown.cpp.

operator==()

bool Steinberg::FUID::operator==

(

const FUID &

f

)

const

Definition at line 264 of file funknown.h.

print() [1/2]

void Steinberg::FUID::print	(	char8 *	string = nullptr,
		int32	style = kINLINE_UID
	)		const

Definition at line 414 of file funknown.cpp.

print() [2/2]

void Steinberg::FUID::print	(	int32	style,
		char8 *	string = nullptr,
		size_t	stringBufferSize = 0
	)		const

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

Parameters

style	can be chosen from the FUID::UIDPrintStyle enumeration.
string	is the output string if not NULL.
stringBufferSize	is the size of the output string

Definition at line 420 of file funknown.cpp.

to4Int()

void Steinberg::FUID::to4Int	(	uint32 &	d1,
		uint32 &	d2,
		uint32 &	d3,
		uint32 &	d4
	)		const

Definition at line 247 of file funknown.cpp.

toRegistryString()

void Steinberg::FUID::toRegistryString

(

char8 *

string

)

const

Converts UID to a string in Microsoft(R) OLE format.

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

Definition at line 383 of file funknown.cpp.

toString()

void Steinberg::FUID::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").

Typical use-case is:

char8[33] strUID = {0};
FUID uid;
if (uid.generate ())
    uid.toString (strUID);

Definition at line 296 of file funknown.cpp.

toTUID() [1/2]

const TUID & Steinberg::FUID::toTUID

(

)

const

Definition at line 332 of file funknown.h.

toTUID() [2/2]

void Steinberg::FUID::toTUID

(

TUID

result

)

const

Definition at line 330 of file funknown.h.

Member Data Documentation

data

TUID Steinberg::FUID::data

protected

Definition at line 344 of file funknown.h.

---

The documentation for this class was generated from the following files:

• juce_audio_processors/format_types/VST3_SDK/pluginterfaces/base/funknown.h
• juce_audio_processors/format_types/VST3_SDK/pluginterfaces/base/funknown.cpp