Enum
The
ENUM
execute obtains the enumerations from a specified enumeration set, as defined in FactoryTalk Batch Equipment Editor
.The format and return for this execute includes:
Execute Format | A FactoryTalk Batch Server supports an execute with this format:[ENUM( Item,UserID,Enumset )] | ||
where: | Item | Item name as specified by the client. | |
UserID | User identification associated with this event. | ||
Enumset | Enumeration set name as defined in the Equipment database. | ||
Action | A successful ENUM execute places the enumerations into the response item. | ||
Return Format | The item populates with this data: | ||
<Enums> | is | <EnumList> \crlf | Cstring.Empty() \crlf | FAIL: <message> | FAILED CString.Empty() is returned for Enumeration Sets that have no enumerations defined. | |
<EnumList> | is | <EnumString> | <EnumString> \t <EnumList> | |
<EnumString> | is | Enumeration string that belongs to the specified enumeration set. | |
The following table shows an example of the return on this execute.
Example: | An execute string consisting of: [ENUM(Station5Enums,Station5\Operator,MATERIALS)] Could place this data in the item Station5Enums for the client: WATER \t FUDGE \t DARK_CHOCOLATE \t STRAWBERRYWHITE_CHOCOLATE \t RASPBERRY \t IC_GERMAN_CHOCOLATE \t PECAN \t EGG_YOLK \t GOOD_EGG \t IC_TRIPLE_CHOCOLATE \t COCOA \t STRAWBERRY_IM \t SUGAR_GRANULATED \t CHAMBORD \t VANILLANEW \t MILK \t VANILLA \t NULL_MATERIAL \t C_CHOCOLATE_BLK_RBERRY_WC \t CARAMEL \t CREAM \t IC_FRENCH_VANILLA \t COCONUT \crlf |
Provide Feedback