struct Core::UIDBytes

Overview

16-Byte Globally Unique Identifier (GUID). More…

#include <coreuid.h>

struct UIDBytes
{
    // enums

    enum Format;

    // fields

    uint32 data1;
    uint16 data2;
    uint16 data3;
    uint8 data4[8];

    // methods

    bool isValid() const;
    bool equals(UIDRef uid) const;
    UIDBytes& prepare();
    UIDBytes& assign(UIDRef uid);
    UIDBytes& operator = (UIDRef uid);
    bool operator == (UIDRef uid) const;
    bool operator != (UIDRef uid) const;
    void toCString(char* cString, int cStringSize, int format = kStandard) const;
    bool fromCString(CStringPtr cString, int format = kStandard);
    static CStringPtr getFormatString(int format);
};

Detailed Documentation

16-Byte Globally Unique Identifier (GUID).

<>

Methods

bool isValid() const

Check if UID is valid, i.e.

not equal to kNullUID.

bool equals(UIDRef uid) const

Compare with other UID.

UIDBytes& prepare()

Initialize with kNullUID.

UIDBytes& assign(UIDRef uid)

Assign other UID.

UIDBytes& operator = (UIDRef uid)

Assign other UID.

void toCString(char* cString, int cStringSize, int format = kStandard) const

Print UID to C-string buffer in given format.

bool fromCString(CStringPtr cString, int format = kStandard)

Scan UID from C-string in given format.

static CStringPtr getFormatString(int format)

Get UID format string.