Guardian Procedure Calls Reference Manual (G06.25+)

Guardian Procedure Calls (F)
Guardian Procedure Calls Reference Manual—522629-013
5-21
FILE_COMPLETE_ Procedure
< -1D An invalid value (file-system error 590 occurs).
omitted Wait indefinitely.
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_ procedure to complete one file. For the
current call to FILE_COMPLETE_, this set temporarily overrides the set of files that
were enabled for completion by previous calls to the FILE_COMPLETE_SET_
procedure.
Note that the FILE_COMPLETE_ procedure does not perform as efficiently when
this temporary override set is used. For better performance, you should use the
“permanent” set of enabled files that is established by calling the
FILE_COMPLETE_SET_ procedure.
For information on how to set the field values of the COMPLETE^ELEMENT
structure, see Structure Definition for COMPLETE^ELEMENT
on page 5-29.
num-complete-elements input
INT
is the total number of Guardian files and OSS files specified in the
complete-element-list parameter. If the complete-element-list
parameter is supplied, this parameter is required.
error-complete-element output
INT .EXT
returns the index to a COMPLETE^ELEMENT structure in the
complete-element-list parameter (the temporary override list) that is in error.
No file from the temporary override list is completed when there is an error.
An
error-complete-element value of -1 is returned if no error occurs or if the
error does not apply to a particular file in
complete-element-list.