Enumerations
- Last UpdatedApr 24, 2025
- 2 minute read
Enumeration Properties:
|
Property Name |
Description |
|---|---|
|
name |
The name of the property. |
|
deprecated |
Optional. Indicates whether the enumeration should be marked as deprecated in the header file. If the associated text is not empty, the compiler includes it as part of the deprecation warning. |
|
description |
The description of the property. |
|
alias |
An alternate name for the enumeration (affects the generated C# model code for the enumeration). |
|
values [] |
An array of enumeration values. |
|
commonType |
Indicates whether the schema entity should be defined in the common header file. The default value is false. Important: Do not change this value for existing tables. For new tables, either keep it set to the default or leave it out. |
|
fixedType |
Indicates whether the schema entity should be defined in the fixed header file. The default value is false. Important: Do not change this value for existing tables. For new tables, either keep it set to the default or leave it out. |
Value Properties:
|
Property Name |
Description |
|---|---|
|
name |
The name of the property. Note: The length of the name string must not exceed 31 characters. |
|
deprecated |
Optional. Indicates whether the value should be marked as deprecated in the header file. If the associated text is not empty, the compiler includes it as part of the deprecation warning. |
|
description |
The description of the property. Note: The length of the description string must not exceed 31 characters. The default value is an empty string. |
|
alias |
An alternate name for the enumeration value (affects the generated C# model code for the enumeration value). |
|
value |
The raw numeric value for the enumeration. |
|
disabled |
Indicates whether the enumeration value is disabled. The default value is false. |