RTC6 boards
Doc. Rev. 1.0.21 en-US
10 RTC6 Commands
600
Ctrl Command save_disk
Function Stores all indexed characters, text strings and/or subroutines to a binary file on a
PC data medium, ordered by index, and returns the number of thereby stored
list commands.
Call
NoOfSavedCommands = save_disk( Name, Mode )
Parameters
Name
File name.
As a pointer to a \0-terminated ANSI string.
Mode
Specifies what is to be stored:
Bit #0 = 1: All indexed characters and text strings are stored.
Bit #1 = 1: All indexed subroutines are stored.
Bit #2 Not evaluated.
…
Bit #31: Not evaluated.
As an unsigned 32-bit value.
Result The number of list commands saved by save_disk.
As an unsigned 32-bit value.
Comments • save_disk can be used together with load_disk, for example, to perform
defragmentation or to apply subsequent protection to subroutines, see Section
”Subsequent Protection and Conversion of Non-Indexed Subroutines”, page 116 and
Section ”Index Management and Defragmentation”, page 115.
• By save_disk, always the complete sets (no individual characters, text strings or
subroutines!) are stored in the specified file. Indexed characters, text strings or
subroutines
that are referenced multiple times with copy_dst_src are also correspondingly
duplicated by save_disk, that is, also stored multiple times. The save_disk command
ignores unreferenced non-indexed (not subsequently referenced by
set_char_pointer,…) characters, text strings and subroutines.
• The number of list commands stored by save_disk can differ
from the number of the list commands stored in the protected RTC6 List Memory area
“List 3“ (= 2
23
–
Mem1
–
Mem2
– get_list_space), due to the following:
– Indexed characters/text strings/subroutines are referenced several times
– Indexed characters/text strings/subroutines reside in the unprotected RTC6 List
Memory area “List 1” or “List 2”
Prior a subsequent load_disk, be sure to compare the returned number with the size
of the protected RTC6 List Memory area “List 3”
(= 2
23
–
Mem1
–
Mem2
).
• No-longer-needed characters (or text strings or subroutines) should be
dereferenced by load_char (or load_text_table or load_sub) directly
followed by list_return previously to save_disk (see Section ”Index Management and
Defragmentation”, page 115).