Using NS3000/iX Network Services (36920-90008)

98 Chapter 5
Network File Transfer
DSCOPY Intrinsic
error set (off). The lower-order bits give the actual NFT
error number in one or the other error set. Thus there
are three NFT error sets. The result parameter
containing these error numbers is interpreted correctly
by the DSCOPYMSG intrinsic. Refer to the NS 3000/iX
Error Messages Reference Manual for these error
messages.
The second word of the array represents the number of
files that were successfully copied.
Description
The DSCOPY intrinsic copies one file into another, performing exactly
the same operations that the DSCOPY command performs. The source
and target files do not have to be on the same node, and the program
that calls the intrinsic does not have to be located on the same node as
either of the files.
The opt parameter determines: (1) whether or not primary output is
enabled, (2) whether to return after all transfers in a series have been
attempted or after the first unsuccessful transfer, and 3) whether the
file transfer will take place from DSCOPYI or from a designated
command file.
If a single or generic transaction is involved, the spec parameter can
contain the full text of the transfer specification, including all
parameters and options, terminated by an ASCII null character. A null
character (numeric zero) alone indicates that the transfer requests are
to be read from the DSCOPYI file.
The returned result parameter indicates whether or not the transfer was
successful. (All the parameters are required; DSCOPY is not
option-variable.)
This intrinsic does not return condition codes. Split stack calls are not
allowed.
NOTE BREAK is disabled during a DSCOPY intrinsic operation. After DSCOPY
completes, BREAK is re-enabled. If BREAK is programmatically
disabled before the DSCOPY call, you must programmatically disable the
BREAK again after the DSCOPY completes.
Programmatic examples may be found at the end of this chapter.