Guardian Procedure Calls Reference Manual

is the total number of Guardian files and OSS files specified in the complete-element-list
parameter.
error-complete-element
output
INT .EXT
returns the index to a COMPLETE^ELEMENT structure in the complete-element-list
parameter indicating the file that is in error. If an error occurs, the call has no affect on the
previously established set of files enabled for completion. 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.
Returned Value
INT
A file-system error code that indicates the outcome of the call.
Structure Definitions for COMPLETE^ELEMENT
The complete-element-list parameter to the FILE_COMPLETE_SET_ and FILE_COMPLETE_
procedures and the info-list parameter to the FILE_COMPLETE_GETINFO_ procedure contain
arrays of COMPLETE^ELEMENT structures. Each structure describes a Guardian file or OSS file
that the caller wants to add to or remove from the set of files enabled for completion.
The COMPLETE^ELEMENT structure is defined in the ZSYS* files. In the TAL ZSYSTAL file, the
structure is defined as:
STRUCT ZSYS^DDL^COMPLETE^ELEMENT^DEF (*);
BEGIN
INT(32) Z^FNUM^FD;
STRUCT Z^OPTIONS;
BEGIN
UNSIGNED(1) Z^SET^FILE;
UNSIGNED(1) Z^FILETYPE;
BIT_FILLER 14;
BIT_FILLER 13;
UNSIGNED(1) Z^READ^READY;
UNSIGNED(1) Z^WRITE^READY;
UNSIGNED(1) Z^EXCEPTION;
END;
INT(32) Z^COMPLETION^TYPE = Z^OPTIONS;
END;
In the C ZSYSC file, the structure is defined as:
typedef struct __zsys_ddl_complete_element {
long z_fnum_fd;
union {
struct {
unsigned short z_set_file:1;
unsigned short z_filetype:1;
short filler_0:14;
short filler_1:13;
unsigned short z_read_ready:1;
unsigned short z_write_ready:1;
unsigned short z_exception:1;
} z_options;
unsigned long z_completion_type;
} u_z_options;
} zsys_ddl_complete_element_def;
376 Guardian Procedure Calls (F)