Guardian Procedure Calls Reference Manual

CEXTDECS (through the included file TNSINTH) defines 32-bit values as the typedef
__int32_t, which for TNS and TNS/R compiles is defined as long and for TNS/E compiles
is defined as int.
Syntax for TAL Programmers
error := FILE_COMPLETE_ ( completion-info ! o
,[ timelimit ] ! i
,[ complete-element-list ] ! i
,[ num-complete-elements ] ! i
,[ error-complete-element ] ); ! o
error := FILE_COMPLETEL_ ( completion-info ! o
,[ timelimit ] ! i
,[ complete-element-list ] ! i
,[ num-complete-elements ] ! i
,[ error-complete-element ] ); ! o
Parameters
completion-info
output
(for FILE_COMPLETE_)INT .EXT:ref:*(ZSYS^DDL^COMPLETION^INFO^DEF)
(for FILE_COMPLETEL_)INT
.EXT:ref:*(ZSYS^DDL^COMPLETION^INFO2^DEF)
is a structure containing completion information for the Guardian file that was completed or
the OSS file that is ready. If an error is returned in the status parameter, no information is
returned in the completion-info parameter. For a description of the fields of the structure,
see Structure Definitions for completion-info (page 369).
timelimit
input
INT(32):value
specifies whether the FILE_COMPLETE[L]_ procedure is to wait for completion or check for
completion. The values of timelimit indicate:
Wait for completion. timelimit specifies the maximum time (in 0.01-second units) from the time of the
FILE_COMPLETE[L]_ call that the caller can wait for completion.
>0D
Check for completion. FILE_COMPLETE[L]_ immediately returns to the caller, regardless of whether
completion has occurred.
= 0D
Wait indefinitely.= -1D
An invalid value (file-system error 590 occurs).< -1D
Wait indefinitely.omitted
complete-element-list
input
INT .EXT:ref:*(ZSYS^DDL^COMPLETE^ELEMENT^DEF)
is an array of COMPLETE^ELEMENT structures, each structure describing one Guardian file
or OSS file. The array explicitly specifies the set of files from which the caller wants the
FILE_COMPLETE[L]_ procedure to complete one file. For the current call to FILE_COMPLETE[L]_,
this set temporarily overrides the set of files that were enabled for completion by previous calls
to the FILE_COMPLETE_SET_ procedure.
FILE_COMPLETE[L]_ Procedures 367