File Utility Program (FUP) Management Programming Manual

FUP Programmatic Interface
File Utility Program (FUP) Management Programming Manual—523322-001
2-13
Discontinuing a Command in Progress
Specifying a File Set
The CHECKSUM command and the DUPLICATE command (without the restartable
option specified) support a template using the asterisk (*) to specify a file set within a
volume or subvolume. A file set can be a single file, all files in a subvolume, or all files
in a volume. You cannot use the asterisk to specify the volume name or the subvolume
name when you specify a file name.
Table 2-4 shows examples of file-set templates. The byte position values in this table
indicate the positions for the NonStop Kernel internal file-name format.
Table 2-4. FUP Files and File Sets
Discontinuing a Command in Progress
FUP checks for CANCEL requests between the processing of each file for a multiple-
file command. To cancel the DUPLICATE and CHECKSUM commands, use the
CANCEL file-system procedure.
Receiving and Decoding a Response Buffer
When your application receives the response buffer, first check for these errors and
execute an error routine (if an error occurs):
•
Errors that were reported by the method used to send and receive the buffer, such
as a file-system error
•
Return token ZSPI-TKN-RETCODE for a value indicating that FUP found an error
in the command
•
Used-length token ZSPI-TKN-USEDLEN from the response buffer, to ensure that
the buffer is not larger than the buffer allocated by your application
Byte Position
1
0 8 6 Files Described
$VOLbbbbSUBVOLbbFILEbbbb A single file
$VOLbbbbSUBVOLbb*bbbbbbb All files in the subvolume
$VOLbbbb*bbbbbbb*bbbbbbb All files in the volume
$VOLbbbb*bbbbbbbFILEbbbb None; name invalid
*bbbbbbb*bbbbbbb*bbbbbbb None; name invalid
Note. For more information, see the Guardian Procedure Calls Reference Manual.