A schema variant is an object used by schema that can hold a single piece of data of varying type. The supported types are:
Type | Description | Function to set |
---|---|---|
bool | A standard C++ boolean type with true and false values | SchemaVariantSetBool |
double | A double precision floating point | SchemaVariantSetNumber |
LPCWSTR | A Uncode string | SchemaVariantSetString |
void * | Any arbitrary data | SchemaVariantSetPointer |
Creating
To create a schema variant you call SchemaVariantCreate followed by a call to set some data into it with the appropriate function. Until you have set data into the newly created schema variant the type of the schema variant will be SystemType::Undefined. Calling schema variant functions on undefined schema variants may fail.
Settings/Changing
You can set/change the value and type of a schema variant with the following calls
Function | Description | Resulting type |
---|---|---|
SchemaVariantSetBool | Sets the schema variant to a boolean value | SystemType::Boolean |
SchemaVariantSetNumber | Sets the schema variant to a double value | SystemType::ANumber |
SchemaVariantSetString | Sets the schema variant to a string value | SystemType::AString |
SchemaVariantSetPointer | Sets the schema variant to a pointer | The user defined type |
SchemaVariantSet | Sets a schema variant from another schema variant | Same as source schema variant |
When schema needs to deal with objects it will inevitably require a schema variant, or an object like a schema request that contains schema variants.