DISKCOPY User Exit

Reference Guide › User Exit Reference › DISKCOPY User Exit

DISKCOPY User Exit

The DISKCOPY user exit allows CA VM:Director to use an alternative application when copying the contents of one minidisk to another.

DISKCOPY caller calltype diruser userid cuu files linkcuu accmode       linkcuu2 accmode2 devtype size blksize Cmdtarget

By default, the system uses the CMS FORMAT and COPYFILE utility programs to copy minidisk contents when disk are moved or the size of the disk changes. If the new disk has the same size and device type, the faster DDR utility is used.

Definitions

caller

The caller of the command.

calltype

The type of call to be made. Indicates one of the following parameters:

‘COPY’ for copying disks formatted with a CMS file system. The target disk is formatted, and all CMS files from the source disk are copied to it.
‘CLONE’ for exact duplication of a disk. The device type and size of the source and target disks must be identical.

diruser

The command issuer ID or the servant userid.

userid

The user ID that owns the source disk.

cuu

The device address of the source disk.

files

The number of files on the source disk.

linkcuu

The link address of the source disk.

accmode

The access mode of the source disk. An ‘*’ indicates a CLONE operation.

Linkcuu2

The link address of the target disk.

Accmode2

The access mode of the target disk. An ‘*’ indicates a CLONE operation.

devtype

The device type of the source disk.

size

The size of the source disk in blocks or cylinders

blksize

The block size of the target disk. An ‘=’ indicates a CLONE operation.

label

The label for the target disk. An ‘=’ indicates a CLONE operation.

CmdTarget

Indicates one of the following:

‘USER ‘if you are not using the servant facility
‘SERVANT ‘if you are using the servant facility

Description

Because of the requirements for issuing macro primitives, the DISKCOPY user exit cannot be written in Assembler. It must be coded in REXX or EXEC2.

The DISKCOPY user exit uses CA VM:Director macro primitives to communicate with the user or servant user ID. The user or servant user ID is the user ID where the minidisk or the SFS directory is accessed. The CA VM:Director macro primitives most likely to be used are:

USER EXECUTE or SERVANT EXECUTE—Issues a command on the user or servant virtual machine. The command text arguments that follow are issued on the indicated machine using CMSCALL.
USER STACK or SERVANT STACK—Places data that you will need later on, such as for a subsequent command, on the user or servant virtual machine program stack. The arguments that follow are stacked in LIFO order on the appropriate program stack.
USER READ or SERVANT READ—Causes the data that exists on the user or servant virtual machine stack to be read to storage on the user or servant virtual machine.

Use these primitives to manipulate the data in the user or servant program stack. To use any of these primitives, precede it with the token TEST. This token allows the primitive to pass a nonzero return code back to the exit. The sample (prototype) user exit contains examples of the use of these primitives.

Return Codes

The following table describes the return codes:

Return Code	Meaning
0	The DISKCOPY user exit successfully copied the requested files to the minidisk.
4	The DISKCOPY user exit defers file copying to the default CA VM:Director copy utility program (COPYFILE or DDR).
8	An error occurred while formatting or accessing the minidisk. A message has been stacked that will be displayed to the issuing user. CA VM:Director treats this as a failure to format the minidisk.

Macros

The DISKCOPY user exit is called by the CLONEDSK macro under the following circumstances:

Called by	Optimized Macro Name	Under These Circumstances
VMXCMD00	CHGMDISK	When a disk is changed with the CHGMDISK command
VMXDUP00	DUPMDISK	When a disk is duplicated with the DUPMDISK command
VMXMANB0	MAN000B0	When a disk is changed with the MANAGE command