Guardian Procedure Calls Reference Manual (G06.25+)

Guardian Procedure Calls (F)
Guardian Procedure Calls Reference Manual—522629-013
5-20
FILE_COMPLETE_ Procedure
Syntax for TAL Programmers
Parameters
status returned value
INT
is a file-system error number indicating the outcome of the call to the
FILE_COMPLETE_ procedure. Error 26 is returned if a
timelimit value of -1D
(indefinite wait) is specified but no I/O operation has been initiated. Error 40 is
returned if a
timelimit value other than -1D is specified and an I/O operation
times out; no operation is considered complete (error 40 does not cause an
outstanding I/O operation to be canceled).
For cases where there is an error indication on a particular file, refer to the
description of the Z^ERROR field in the structure returned by the
completion-
info parameter. For a description of the fields of this structure, see “Structure
Definition for
completion-info.”
completion-info output
INT .EXT:ref:*(ZSYS^DDL^COMPLETION^INFO^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 Definition for
completion-
info
.”
timelimit input
INT(32):value
specifies whether the FILE_COMPLETE_ procedure is to wait for completion or
check for completion. The following values of
timelimit indicate:
>0D Wait for completion. timelimit specifies the maximum time (in
0.01-second units) from the time of the FILE_COMPLETE_ call that
the caller can wait for completion.
= 0D Check for completion. FILE_COMPLETE_ immediately returns to
the caller, regardless of whether completion has occurred.
= -1D Wait indefinitely.
status := FILE_COMPLETE_ ( completion-info ! o
,[ timelimit ] ! i
,[ complete-element-list ] ! i
,[ num-complete-elements ] ! i
,[ error-complete-element ] ); ! o