Steinberg::FUID Class Reference

#include <funknown.h>

List of all members.

Public Types
	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)"
enum	UIDPrintStyle { kINLINE_UID, kDECLARE_UID, kFUID, kCLASS_UID }
Public Member Functions
	FUID ()
	FUID (const char *)
	FUID (int32 l1, int32 l2, int32 l3, int32 l4)
	FUID (const FUID &)
virtual	~FUID ()
bool	generate ()
bool	isValid () const
FUID &	operator= (const FUID &f)
FUID &	operator= (const char *uid)
bool	operator== (const FUID &f) const
bool	operator== (const char *uid) const
bool	operator!= (const FUID &f) const
bool	operator!= (const char *uid) const
	operator const char * () const
	operator char * ()
int32	getLong1 () const
int32	getLong2 () const
int32	getLong3 () const
int32	getLong4 () const
void	toString (char *string) const
bool	fromString (const char *string)
void	toRegistryString (char *string) const
bool	fromRegistryString (const char *string)
void	print (char *string=0, int32 style=kINLINE_UID) const
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).

Definition at line 231 of file funknown.h.

---

Member Enumeration Documentation

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 284 of file funknown.h.

---

Constructor & Destructor Documentation

Steinberg::FUID::FUID

(

)

Definition at line 99 of file funknown.cpp.

Steinberg::FUID::FUID

(

const char *

)

Definition at line 105 of file funknown.cpp.

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

Definition at line 113 of file funknown.cpp.

Steinberg::FUID::FUID

(

const FUID &

)

Definition at line 153 of file funknown.cpp.

Steinberg::FUID::~FUID

(

)

[virtual]

Definition at line 159 of file funknown.cpp.

---

Member Function Documentation

bool Steinberg::FUID::fromRegistryString

(

const char *

string

)

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

Definition at line 278 of file funknown.cpp.

bool Steinberg::FUID::fromString

(

const char *

string

)

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

Definition at line 347 of file funknown.cpp.

bool Steinberg::FUID::generate

(

)

Generate 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 163 of file funknown.cpp.

int32 Steinberg::FUID::getLong1

(

)

const

Definition at line 220 of file funknown.cpp.

int32 Steinberg::FUID::getLong2

(

)

const

Definition at line 230 of file funknown.cpp.

int32 Steinberg::FUID::getLong3

(

)

const

Definition at line 240 of file funknown.cpp.

int32 Steinberg::FUID::getLong4

(

)

const

Definition at line 250 of file funknown.cpp.

bool Steinberg::FUID::isValid

(

)

const

Check if the UID data is valid. The default constructor initializes the memory with zeros.

Definition at line 197 of file funknown.cpp.

Steinberg::FUID::operator char *

(

)

[inline]

Definition at line 260 of file funknown.h.

Steinberg::FUID::operator const char *

(

)

const [inline]

Definition at line 259 of file funknown.h.

bool Steinberg::FUID::operator!=

(

const char *

uid

)

const [inline]

Definition at line 257 of file funknown.h.

bool Steinberg::FUID::operator!=

(

const FUID &

f

)

const [inline]

Definition at line 256 of file funknown.h.

FUID & Steinberg::FUID::operator=

(

const char *

uid

)

Definition at line 213 of file funknown.cpp.

FUID & Steinberg::FUID::operator=

(

const FUID &

f

)

Definition at line 206 of file funknown.cpp.

bool Steinberg::FUID::operator==

(

const char *

uid

)

const [inline]

Definition at line 254 of file funknown.h.

bool Steinberg::FUID::operator==

(

const FUID &

f

)

const [inline]

Definition at line 253 of file funknown.h.

void Steinberg::FUID::print	(	char *	string = 0,
		int32	style = kINLINE_UID
	)			const

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

Parameters:

style

can be chosen from the FUID::UIDPrintStyle enumeration

Definition at line 378 of file funknown.cpp.

void Steinberg::FUID::toRegistryString

(

char *

string

)

const

Convert UID to a string in Microsoft® OLE format. (e.g. "{c200e360-38c5-11ce-ae62-08002b2b79ef}")

Definition at line 316 of file funknown.cpp.

void Steinberg::FUID::toString

(

char *

string

)

const

Convert UID to a string. The string will be 32 characters int32, representing the hexadecimal values of each data byte (e.g. "9127BE30160E4BB69966670AA6087880").

Definition at line 260 of file funknown.cpp.

void Steinberg::FUID::toTUID

(

TUID

result

)

const

Definition at line 419 of file funknown.cpp.

---

Member Data Documentation

TUID Steinberg::FUID::data [protected]

Definition at line 298 of file funknown.h.

---

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

• funknown.h
• funknown.cpp

---

Copyright ©2008 Steinberg Media Technologies. All Rights Reserved.