Scanlab RTC6 PCIe Board - Load_Char

RTC6 boards
Doc. Rev. 1.0.21 en-US
10 RTC6 Commands
493
innovators for industry
Ctrl Command load_char
Function Assigns a desired index to a character defined by subsequent list commands, and loads the
character into the protected RTC6 List Memory area “List 3”.
Call load_char( Char )
Parameters Char Index of the indexed character. As an unsigned 32-bit value.
Allowed value range: [0…1023].
Comments • Up to 1024 indexed characters, hence 4 character sets with 256 indexed characters per
set, can be stored. For defining character sets, the following applies:
Char = character set number × 256 + ASCII number of the character
(character sets are numbered 0 to 3).
If Char > 1023 then load_char is ignored (get_last_error return code
RTC6_PARAM_ERROR ).
• The addresses in the protected RTC6 List Memory area “List 3” where the character
definitions are to be stored are automatically determined and internally managed. This
management is independent of that for indexed subroutines (see load_sub) and text
string definitions (see load_text_table).
• Indexed character definitions must be terminated with a list_return call. This is a
prerequisite for actual storage of the commands, entry of the start address into the
internal management table, and initiating a flush of the buffered list input, see
Chapter 6.4.1 ”Loading Lists”, page 105. Otherwise (the input pointer is altered
without a preceding list_return), the character definition with this index is not
available.
• An indexed character definition is not stored if the protected RTC6 List Memory area
“List 3” has not been previously configured for a sufficient size beyond “List 1” and
“List 2”.
• If list_return is the next command after load_char, then the corresponding character
definition is deleted from the internal management table.
• Observe all notes in Chapter 6.5.2 ”Character Sets and Text Strings”, page 118.
RTC4RTC6 New command.
RTC5RTC6 Unchanged functionality.
Version info Available as of DLL 600, OUT 600, RBF 600.
References list_return, load_sub, load_text_table