Initializing help system before first use

executorfetchrunlogfragment

executorfetchrunlogfragment

Purpose
Downloads a fragment of the run log of the given execution.
Synopsis
function executorfetchrunlogfragment(exec:Executor, execution:ModelExecution, firstline:integer, maxlines:integer):RunLogFragment
Arguments
exec 
The Executor on which the execution resides
execution 
The execution whose run log we should request
firstline 
The index of the first line of the run log to fetch, where the first line of the run log has index 1
maxlines 
The maximum number of lines to return in the fragment
Example 
frag := executorfetchrunlogfragment( myexecutor, myexecution, 10, MAX_INT )
if myexecutor.status<>EXECUTOR_OK then
  writeln("Error returned by Executor: ",myexecutor.lasterror)
  exit(1)
end-if
forall (line in frag.lines) do
  writeln(line)
end-do
Further information
1. After calling, check the value of exec.status for any errors.
2. The procedure will not return until the execution run log fragment has been downloaded or an error was detected.
3. Only the id field of the ModelExecution record is read by this function.
4. If the execution has not completed, this procedure will download a fragment based on however much of the run log is available.
5. When passing a value of firstline greater than 1, always check the logversion of the returned fragment; if this value is different from the logversion of previously fetched fragments then the execution has been restarted and you should re-fetch the run log from line 1.
Related topics
getstatus executorfetchrunlog

Parent Topic Subroutines

© 2001-2019 Fair Isaac Corporation. All rights reserved. This documentation is the property of Fair Isaac Corporation (“FICO”). Receipt or possession of this documentation does not convey rights to disclose, reproduce, make derivative works, use, or allow others to use it except solely for internal evaluation purposes to determine whether to purchase a license to the software described in this documentation, or as otherwise set forth in a written software license agreement between you and FICO (or a FICO affiliate). Use of this documentation and the software described in it must conform strictly to the foregoing permitted uses, and no other use is permitted.