Editing Data dictionary (section)

== 4. Copybook: primes-ui.cpy ==

'''Control block for the UI tier; included by all four programs.'''

{|
!width="20%"| Name
!width="20%"| Level
!width="20%"| Picture
!width="20%"| Usage
!width="20%"| Description
|-
| <code>primes-ui</code>
| 01
| —
| —
| Root of UI control block; passed as linkage to primesui
|-
| <code>ui-methods</code>
| 03
| X(32)
| DISPLAY
| Operation verb set by caller
|-
| — <code>write-ui</code>
| 88
| —
| —
| VALUE “write” — add one prime row to print buffer
|-
| — <code>message-ui</code>
| 88
| —
| —
| VALUE “log-message” — display console message
|-
| — <code>start-ui</code>
| 88
| —
| —
| VALUE “start” — open print file
|-
| — <code>stop-ui</code>
| 88
| —
| —
| VALUE “stop” — flush and close print file
|-
| <code>process-message</code>
| 03
| —
| —
| Structured console log record
|-
| <code>program-name</code>
| 05
| X(20)
| DISPLAY
| Name of the calling program (for log messages)
|-
| <code>program-line</code>
| 05
| —
| —
| Group: paragraph name + message text
|-
| <code>program-paragraph</code>
| 07
| X(20)
| DISPLAY
| Name of the calling paragraph
|-
| <code>program-message</code>
| 07
| X(92)
| DISPLAY
| Human-readable status or error message
|-
| <code>u-primes</code>
| 03
| —
| —
| One prime row for the print writer
|-
| <code>u-sequence</code>
| 05
| 9(9)
| DISPLAY
| Prime sequence number (ident) to print
|-
| <code>u-number</code>
| 05
| 9(9)
| DISPLAY
| Prime value to print
|-
| <code>ui-method-result</code>
| 03
| 9(2)
| DISPLAY
| Result code from primesui; initial value ZERO
|-
| — <code>ui-method-ok</code>
| 88
| —
| —
| VALUE 0 — operation succeeded
|-
| — <code>ui-method-nok</code>
| 88
| —
| —
| VALUE 1 — operation failed
|}


-----

<span id="copybook-primes-table.cpy"></span>