RTC
®
5 PC Interface Board
Rev. 1.9 e
10 Commands And Functions
328
innovators for industry
Ctrl Command load_correction_file
Function
loads the specified image field correction file into RTC
®
5 memory (as table #1, 2,3 or 4)
with the most recently used parameter values (or
the default parameter values).
Call
ErrorNo = load_correction_file( Name, No, Dim )
Parameters
Name
name of the correction file as a pointer to a null-terminated ANSI string
No
this number (unsigned 32-bit value) determines whether the file shall be
stored as correction table #1, 2, 3 or 4
Allowed values: [1…4]
Dim
This parameter (an unsigned 32-bit value) determines whether the file should
be stored as a 2D correction table or (if possible) as a 3D correction table (also
see comments):
= 2:
2D and 3D correction files will be stored as a 2D correction table
(downgraded when necessary)
= 3:
if the 3D option
is
enabled, 2D and 3D correction files will be stored
as a 3D correction table (upgraded if necessary);
If the 3D option is
not
enabled (default),
then the command executes with
Dim
= 2.
otherwise, the parameter has no effect:
a 2D correction file will be stored as a 2D correction table;
a 3D correction file will be stored as a 3D correction table if the 3D
option
is
enabled and as a 2D correction table (downgraded) if the 3D
option is
not
enabled.
Result
error code as an unsigned 32-bit value:
Value
Description
0
Success.
1
File error (file corrupt or incomplete).
2
Memory error (DLL-internal, WINDOWS system memory).
3
File-open error (empty string submitted for
Name
parameter, file not found, etc.).
4
DSP memory error
5
PCI download error (driver error).
8
System driver not found (
return code: RTC5_ACCESS_DENIED)
10
Parameter error (incorrect
No
).
11
Access error: board reserved for another application (
return code:
RTC5_ACCESS_DENIED) or version check has detected an error (OUT or RTC version not compatible
to the current DLL version,
return code: RTC5_ACCESS_DENIED |
RTC5_VERSION_MISMATCH).
12
Warning: 3D table or Dim = 3 selected, but the 3D option is not enabled. The system will
subsequently operate as an ordinary 2D system (this warning is only returned, if no other error has
occurred).
13
Busy error: no download, board is BUSY or INTERNAL-BUSY (
return code: RTC5_BUSY)
14
PCI upload error (driver error, only applicable for download verification)
15
Verify error (only applicable for download verification)