context
OpenVMS usage:longword_unsigned
type: longword (unsigned)
access: read only
mechanism: by reference
The longword address that received the common file qualifier
database address from a prior call to UTIL$CQUAL_FILE_PARSE.
user_fab
OpenVMS usage:longword_unsigned
type: longword (unsigned)
access: read only
mechanism: by reference
The FAB address of the file to be evaluated. This FAB must point
to a valid NAM or NAML block. If the file is open and the file
header criteria are to be evaluated, the appropriate XABs (XABPRO
or XABDAT) must be chained to the FAB and properly filled in by
RMS. If the file is not open when this routine is called, then
the XAB chain is not necessary, but may be present. This argument
is optional. If it is not present, the file_name parameter must
be present. Both arguments may not be present at the same time.
file_name
OpenVMS usage:longword_unsigned
type: longword (unsigned)
access: read only
mechanism: by reference
The file name descriptor address of the file to be processed.
This parameter can be used instead of the user_fab argument. Both
arguments may not be present at the same time.
prompt_string_1
OpenVMS usage:longword_unsigned
type: longword (unsigned)
access: read only
mechanism: by reference
Longword address of a prompt string descriptor. This prompt is
used when prompting to a terminal device and the current prompt
form is UTIL$K_CQF_SHORT.
prompt_string_2
OpenVMS usage:longword_unsigned
type: longword (unsigned)
access: read only
mechanism: by descriptor
Longword address of a prompt string descriptor. This prompt is
used when prompting to a terminal device and the current prompt
form is UTIL$K_CQF_LONG.
prompt_rtn
OpenVMS usage:procedure
type: longword (unsigned)
access: function call
mechanism: by value
User-supplied longword routine address used for prompting and
accepting input from the user. The user routine is responsible
for end-of-file processing and must return RMS$_EOF when
appropriate.
current_form
OpenVMS usage:longword_unsigned
type: longword (unsigned)
access: read write
mechanism: by reference
This optional parameter supplies the initial prompt form
displayed to the user. If it contains the value UTIL$K_CQF_
UNSPECIFIED, then the form last requested by the user is used
if that form is available. If there was no previous call to
UTIL$CQUAL_FILE_MATCH, and the current_form is unspecified,
UTIL$K_CQF_SHORT is assumed.
When exiting UTIL$CQUAL_FILE_MATCH, the current_form parameter
contains the last user requested prompt form. If a previous
call to UTIL$CQUAL_FILE_MATCH requested quit processing or quit
confirmation prompting, then this parameter is not modified.
disable
OpenVMS usage:longword_unsigned
type: longword (unsigned)
access: read only
mechanism: by reference
Longword of bit flags. This optional parameter specifies which
common file qualifiers are ignored in the current call to
UTIL$CQUAL_FILE_MATCH. Qualifiers that cannot be ignored are
/CREATED, /MODIFIED, /EXPIRED, and /BACKUP).