Key Segment Loop Expansion Tokens

 

Key segment loop expansion tokens are used to insert information about the current key segment being processed within the context of a key segment loop into the output stream. Key segment loop tokens can only be used inside a key segment loop.

 

Key Segment Loop Token

Description

<SEGMENT_CSTYPE>

 

Inserts C# data type of the field associated with the current key segment.

<SEGMENT_DESC>

 

Inserts the description of the field associated with the current key segment (if segment kind is field). 

<SEGMENT_IDXTYPE>

 

Inserts the index type of the key segment.

<SEGMENT_KIND>

 

Inserts a numeric code for the kind of the current key segment.

<SEGMENT_LENGTH>

 

Inserts the length of the key segment.

<SEGMENT_LITVAL>

 

Inserts the literal value of the key segment (if segment kind is "literal").

<SEGMENT_MAPPEDNAME>

 

Inerts the name of the mapped field corresponding to the current key segment (if segment kind is field). 

<SEGMENT_NAME>

 

Inserts the name of the field associated with the current key segment (if segment kind is field). 

<SEGMENT_NUMBER>

 

Inserts the one-based key segment number.

<SEGMENT_ORDER>

 

Inserts the ordering sequence of the current key segment, ascending or descending.

<SEGMENT_ORDER_CODE>

 

Inserts a one letter code indicating the ordering sequence of the current key segment, A or D.
 

<SEGMENT_POSITION>

 

Inserts the one-based position of the key segment in the record.

<SEGMENT_SEQUENCE>

 

Inserts the ordering sequence of the current key segment, ascending or descending.

<SEGMENT_SNTYPE>

 

Inserts Synergy.NET data type of the field associated with the current key segment.

<SEGMENT_STRUCTURE>

 

Inserts the name of the structure containing the key segment (if the segment kind is "external").

<SEGMENT_SPEC>

 

Inserts Synergy data type and size of the field associated with the current key segment. For example:

<SEGMENT_TYPE>

 

Inserts a word which represents the index type of the current key segment.

<SEGMENT_VBTYPE>

 

Inserts VB data type of the field associated with the current key segment.

 

 


Copyright © 2018  Synergex International, Inc.