|
Interface Technology Basics VST 3.7
SDK for developing VST plug-in
|
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 () | |
| 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. | |
| 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). | |
| 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 |
Handling 16 Byte Globally Unique Identifiers.
Each interface declares its identifier as static member inside the interface namespace (e.g. FUnknown::iid).
| typedef char8 String[33] |
| enum UIDPrintStyle |
| FUID | ( | ) |
|
inlinevirtual |
| 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.
|
inline |
|
inline |
|
inline |
| uint32 getLong1 | ( | ) | const |
| uint32 getLong2 | ( | ) | const |
| uint32 getLong3 | ( | ) | const |
| uint32 getLong4 | ( | ) | 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").
Typical use-case is:
| 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(R) OLE format.
(e.g. "{c200e360-38c5-11ce-ae62-08002b2b79ef}")
| bool fromRegistryString | ( | const char8 * | string | ) |
Sets the UID data from a string in Microsoft(R) OLE format.
Prints the UID to a string (or debug output if string is NULL).
| 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 |
|
inline |
|
inline |
|
inline |
|
protected |