Guardian Procedure Calls Reference Manual (G06.25+)

Guardian Procedure Calls (F)
Guardian Procedure Calls Reference Manual—522629-013
5-201
FILENAME_SCAN_ Procedure
Parameters
error returned value
INT
is a file-system error number indicating the outcome of the operation. Possible
values include:
0 Syntactically correct name found for
count bytes; see description of
count parameter
13 The form of the name found is incorrect; also, various program and
resource errors
string:length input:input
STRING .EXT:ref:*, INT:value
is a character string to be searched for a valid file name.
string must be exactly
length bytes long. A valid file name must begin at the first character of string.
It can occupy the entire length of
string, or it can occupy the left-hand portion of
string and be followed by characters that cannot appear in a valid file name or
file-name pattern.
count output
INT .EXT:ref:1
is the number of characters occupied by the name if a valid name is found. If error
13 is returned in
error, count contains the number of characters examined when
the name was determined to be invalid. To know that the entire input string
constitutes a valid name, you should verify that
count is equal to length. See
“Example.”
kind output
INT .EXT:ref:1
identifies the class of name that was found. Possible values are:
0 File name (that is, the name of an entity).
1 File-name pattern. This value can be returned only if
options.<15> is
equal to 1. If the input is a name as well as a file-name pattern (that is, it
does not contain an asterisk or question mark), FILENAME_SCAN_
classifies it as a name and not a pattern.
2 DEFINE name.