Struct EventProperty

Struct Documentation

struct Microsoft::Applications::Events::EventProperty

The EventProperty structure represents a C++11 variant object that holds an event property type and an event property value.

Public Types

enum [anonymous]

This anonymous enumeration contains a set of values that specify the types that are supported by events collector.

Note: These enum values should be in sync with Java enum com.microsoft.applications.events.EventPropertyType

Values:

enumerator TYPE_STRING

A string.

enumerator TYPE_INT64

A 64-bit signed integer.

enumerator TYPE_DOUBLE

A double.

enumerator TYPE_TIME

A date/time object represented in .NET ticks.

enumerator TYPE_BOOLEAN

A boolean.

enumerator TYPE_GUID

A GUID.

enumerator TYPE_STRING_ARRAY

String

enumerator TYPE_INT64_ARRAY

64-bit signed integer

enumerator TYPE_DOUBLE_ARRAY

double

enumerator TYPE_GUID_ARRAY

GUID

Public Functions

EventProperty(const EventProperty &source)

EventProperty copy constructor

Parameters

source – Right-hand side value of object

EventProperty(EventProperty &&source)

The EventProperty move constructor.

Parameters

source – The EventProperty object to move.

bool operator==(const EventProperty &source) const

The EventProperty equalto operator.

EventProperty &operator=(const EventProperty &source)

An EventProperty assignment operator that takes an EventProperty object.

EventProperty &operator=(const std::string &value)

An EventProperty assignment operator that takes a string value.

EventProperty &operator=(const char *value)

An EventProperty assignment operator that takes a character pointer to a string.

EventProperty &operator=(int64_t value)

An EventProperty assignment operator that takes an int64_t value.

EventProperty &operator=(int8_t value)

An EventProperty assignment operator that takes an int8_t value.

EventProperty &operator=(int16_t value)

An EventProperty assignment operator that takes an int16_t value.

EventProperty &operator=(int32_t value)

An EventProperty assignment operator that takes an int32_t value.

EventProperty &operator=(uint8_t value)

An EventProperty assignment operator that takes a uint8_t value.

EventProperty &operator=(uint16_t value)

An EventProperty assignment operator that takes a uint16_t value.

EventProperty &operator=(uint32_t value)

An EventProperty assignment operator that takes a uint32_t value.

EventProperty &operator=(uint64_t value)

An EventProperty assignment operator that takes a uint64_t value.

EventProperty &operator=(const std::vector<int64_t> &value)
EventProperty &operator=(const std::vector<double> &value)
EventProperty &operator=(const std::vector<GUID_t> &value)
EventProperty &operator=(const std::vector<std::string> &value)
EventProperty &operator=(double value)

An EventProperty assignment operator that takes a double.

EventProperty &operator=(bool value)

An EventProperty assignment operator that takes a boolean value.

EventProperty &operator=(time_ticks_t value)

An EventProperty assignment operator that takes a time_ticks_t value.

EventProperty &operator=(GUID_t value)

An EventProperty assignment operator that takes a GUID_t value.

void clear()

Clears the object values, deallocating memory when needed.

virtual ~EventProperty()

The EventProperty destructor.

EventProperty()

The EventProperty default constructor.

EventProperty(const char *value, PiiKind piiKind = PiiKind_None, DataCategory category = DataCategory_PartC)

The EventProperty constructor, taking a character pointer to a string, and the kind of personal identifiable information.

EventProperty constructor for string value

Parameters

  • value – A constant character pointer to a string.

  • piiKind – The kind of personal identifiable information.

  • value – string value

  • piiKind – Pii kind

EventProperty(const std::string &value, PiiKind piiKind = PiiKind_None, DataCategory category = DataCategory_PartC)

EventProperty constructor for string value

Parameters

  • value – string value

  • piiKind – Pii kind

EventProperty(int64_t value, PiiKind piiKind = PiiKind_None, DataCategory category = DataCategory_PartC)

EventProperty constructor for int64 value

Parameters

  • value – int64_t value

  • piiKind – Pii kind

EventProperty(double value, PiiKind piiKind = PiiKind_None, DataCategory category = DataCategory_PartC)

EventProperty constructor for double value

Parameters

  • value – double value

  • piiKind – Pii kind

EventProperty(time_ticks_t value, PiiKind piiKind = PiiKind_None, DataCategory category = DataCategory_PartC)

EventProperty constructor for time in .NET ticks

Parameters

  • value – time_ticks_t value - time in .NET ticks

  • piiKind – Pii kind

EventProperty(bool value, PiiKind piiKind = PiiKind_None, DataCategory category = DataCategory_PartC)

EventProperty constructor for boolean value

Parameters

  • value – boolean value

  • piiKind – Pii kind

EventProperty(GUID_t value, PiiKind piiKind = PiiKind_None, DataCategory category = DataCategory_PartC)

EventProperty constructor for GUID

Parameters

  • value – GUID_t value

  • piiKind – Pii kind

EventProperty(int8_t value, PiiKind piiKind = PiiKind_None, DataCategory category = DataCategory_PartC)
EventProperty(int16_t value, PiiKind piiKind = PiiKind_None, DataCategory category = DataCategory_PartC)
EventProperty(int32_t value, PiiKind piiKind = PiiKind_None, DataCategory category = DataCategory_PartC)
EventProperty(uint8_t value, PiiKind piiKind = PiiKind_None, DataCategory category = DataCategory_PartC)
EventProperty(uint16_t value, PiiKind piiKind = PiiKind_None, DataCategory category = DataCategory_PartC)
EventProperty(uint32_t value, PiiKind piiKind = PiiKind_None, DataCategory category = DataCategory_PartC)
EventProperty(uint64_t value, PiiKind piiKind = PiiKind_None, DataCategory category = DataCategory_PartC)
EventProperty(std::vector<int64_t> &value, PiiKind piiKind = PiiKind_None, DataCategory category = DataCategory_PartC)
EventProperty(std::vector<double> &value, PiiKind piiKind = PiiKind_None, DataCategory category = DataCategory_PartC)
EventProperty(std::vector<GUID_t> &value, PiiKind piiKind = PiiKind_None, DataCategory category = DataCategory_PartC)
EventProperty(std::vector<std::string> &value, PiiKind piiKind = PiiKind_None, DataCategory category = DataCategory_PartC)
bool empty()

Returns true when the type is string AND the value is empty.

virtual std::string to_string() const

Returns a string representation of this object.

Public Members

enum Microsoft::Applications::Events::EventProperty::[anonymous] type

This anonymous enumeration contains a set of values that specify the types that are supported by events collector.

Note: These enum values should be in sync with Java enum com.microsoft.applications.events.EventPropertyType

PiiKind piiKind

The kind of PII (Personal Identifiable Information) for an event.

DataCategory dataCategory = DataCategory_PartC
char *as_string
int64_t as_int64
double as_double
bool as_bool
GUID_t as_guid
time_ticks_t as_time_ticks
std::vector<int64_t> *as_longArray
std::vector<double> *as_doubleArray
std::vector<GUID_t> *as_guidArray
std::vector<std::string> *as_stringArray
union Microsoft::Applications::Events::EventProperty::[anonymous] [anonymous]

Variant object value

Public Static Functions

static const char *type_name(unsigned typeId)

Debug routine that returns string representation of type name