Enumeration Loop Expansion Tokens

 

Enumeration loop expansion tokens are used to insert information about the current enumeration being processed within the context of an enumeration loop into the output stream. Enumeration loop tokens can only be used inside an enumeration loop.

 

Enumeration Loop Token

Description

<ENUM_COUNT>

 

Inserts the total number of repository enumerations being processed.  For regular enumeration loops this will be the number of enumerations defined in the repository.  For structure enumeration loops this will be the number of enumerations referenced by the repository structure being processed.

 

<ENUM_DESCRIPTION>

 

Inserts the short description of the enumeration. You can test whether an enumeration has a description using the enumeration loop <IF DESCRIPTION> expression.

<ENUM_LONG_DESCRIPTION>

 

Inserts the long description of the enumeration. You can test whether an enumeration has a long description using the enumeration loop <IF LONG_DESCRIPTION> expression.

<ENUM_MEMBER_COUNT>

 

Inserts the number of members that comprise to the enumeration.

<ENUM_NAME>

 

Inserts the name of the enumeration.

 

Alternates:  <enum_name>, <Enum_Name>, <Enum_name>, <EnumName>, <enumName>

<ENUM_NUMBER>

 

Inserts the one-based index within the collection of enumerations being processed, of the enumeration that is currently being processed.

 

 


Copyright © 2021  Synergex International, Inc.