RTC
®
5 PC Interface Board
Rev. 1.9 e
10 Commands And Functions
343
innovators for industry
Ctrl Command load_stretch_table
Function
loads a table with data pairs from an ASCII text file for enhanced 3D correction (see
Call
NoOfDataPairs = load_stretch_table( Name, No )
Parameters
Name
name of the text file as a pointer to a null-terminated ANSI string
(the text file may contain one or more tables)
or NULL
No
signed 32-bit value
• For
No
0, this parameter specifies which table in the text file shall be
loaded (the parameter corresponds to the extension
<No>
of the instruction
[StretchTable<No>]
at the beginning of the desired table).
•
No
< 0: reserved for future use
Result
signed 32-bit value (a positive error code in case of an error, the negative number of found
data pairs in case of success):
Value
Description
< 0
Success.
The absolute value of the return value is equal to the number of valid data pairs found in the table.
0
Reserved
2
Out of Memory (not enough WINDOWS memory)
3
File not found.
4
DSP memory error
5
BUSY error, board is BUSY or INTERNAL-BUSY, no download (
return code
RTC5_BUSY
).
6
Data error: data pairs missing
11
PCI download error (
return code
RTC5_SEND_ERROR
)
13
The specified table number was not found in the file.
15
Verify error (
return code
RTC5_VERIFY_ERROR
, only possible with
option set)
Comments
• Details about enhanced 3D correction (e.g. format requirements for the text file’s table
entries) are described on
.
• A successfully loaded table will activate the new enhanced 3D correction. Here,
load_stretch_table
will overwrite any previously loaded table.
• If
Name
is
not
NULL, but no table was successfully read, then
load_stretch_table
will
return an error code (e.g. code 13 if a
No
value is specified for which no
[
StretchTable
<No>]
entry is included in the text file), but otherwise will have no effect
(i.e. any previous successfully downloaded table will stay enabled).
• If
Name
is NULL, then
load_stretch_table
disables any enhanced 3D correction enabled
by a previous
load_stretch_table
command.
• The command will
not
be executed (
return code
:
RTC5_BUSY
) if the
board’s BUSY status is currently set (list is being processed or has been halted via
) or the board’s INTERNAL-BUSY status is currently set. In contrast, the
command is executed when a list has been paused via
PAUSED status set).
• During execution of
load_stretch_table
, external starts will be suppressed.
• Before loading a table,
load_stretch_table
performs a DSP memory check. In case of
an error, error code 4 is returned.
RTC
®
4
RTC
®
5 new command
Version info
Available beginning with version DLL 536, OUT 536