Guardian Procedure Calls Reference Manual (G06.25+)

Guardian Procedure Calls (F)
Guardian Procedure Calls Reference Manual—522629-013
5-172
FILENAME_DECOMPOSE_ Procedure
<15> = 1 Include suffix, that is, the entire portion of filename that follows
the part specified by
level.
= 0 Do not include suffix.
The default value is 0.
subpart input
INT:value
specifies a single section to be extracted from the level 0 (destination) part of
filename. This parameter applies only to process file names, because only a
process file name can have a level 0 part with multiple components. Valid values
are:
0 Extract whole destination, that is, all sections occurring before the period (.).
1 Extract processor, that is, the numeric part designating the processor for an
unnamed process.
2 Extract PIN, that is, the numeric part that gives the process identification
number for an unnamed process.
3 Extract sequence number, that is, the numeric part that gives the sequence
number of a process.
4 Extract name, that is, the alphanumeric section that begins with a dollar sign
and ends at the first colon or period.
The default value is 0.
You should specify a nonzero value for
subpart only when level is 0 and bits 14
and 15 (extract prefix and extract suffix) of
options are 0.
Considerations
•
When the FILENAME_DECOMPOSE_ procedure returns a portion of a file name,
it does not include leading or trailing separators (the characters . :). Internal
separators between the parts of the returned portion are included. Special
characters that are part of the name (the characters $ \ #) are always included.
•
The filename parameter can contain a partially qualified file name or file-name
pattern. Unless you specify
options.<13> = 1 (no default values), the returned
string reflects the resolution of the file name using the contents of your
=_DEFAULTS DEFINE. If you request a name part that is absent after the file
name has been resolved, either because the default values did not apply or
because you specified
options.<13> = 1, FILENAME_DECOMPOSE_ returns a
value of 0 for
piece-length.
Caution. Passing an invalid file name or file-name pattern to this procedure can result in a
trap, a signal, or data corruption. To verify that a file name or file-name pattern is valid, use the
FILENAME_SCAN_ procedure.