Scanlab RTC6 PCIe Board - Load_Sub

RTC6 boards
Doc. Rev. 1.0.21 en-US
10 RTC6 Commands
514
innovators for industry
Ctrl Command load_sub
Function Assigns the specified index to a subroutine defined by subsequent list commands and
loads the subroutine into the protected RTC6 List Memory area “List 3”.
Call load_sub( Index )
Parameters Index Index of the indexed subroutine.
As an unsigned 32-bit value.
Allowed value range: [0…1023].
Comments • Up to 1024 indexed subroutines can be stored. If Index > 1023 then load_sub is
ignored (get_last_error return code RTC6_PARAM_ERROR ).
• The address in the protected RTC6 List Memory area “List 3” where the subroutine
should be stored is automatically determined and internally managed.
• Indexed subroutines must be terminated by 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 subroutine with this index is not available.
• An indexed subroutine 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_sub, then the corresponding subroutine
is deleted from the internal management table.
• Indexed subroutines can be called by the sub_call command along with the
corresponding index (see Section ”General Information on Calling Subroutines”,
page 114).
• Observe all notes in Section ”Indexed Subroutines”, page 113.
RTC4RTC6 New command.
RTC5RTC6 Unchanged functionality.
Version info Available as of DLL 600, OUT 600, RBF 600.
References list_return, sub_call, load_char, load_text_table