Receive Cancel command

You can cancel receiving in progress.

Program interface

CALL library name/UTLSCAN PARM(['LIB=library name'] ['F=fileid'] ['H=hostname'] 
     ['TRID=transfer-id'] ['G'] ['OUTPUT=filename'] ['EXIT' CL variable name])

Explanation of parameters

LIB=Library name

Library name in which HULFT is installed ("HULFT" by default)

Specify this parameter as an alphanumeric character string of 10 bytes or less starting with an alphabet.

F=fileid

File ID of which receiving to be canceled (Optional)

Specify a string of alphanumeric characters (and "_" if desired) that is within 50 bytes.

To cancel all instant transfers at the same time, specify "_INSTANT_TRANSFER_".

To cancel an individual instant transfer, specify with "TRID=".

If omitted, receiving-side transferring instances for all target hosts will be canceled.

H=hostname

Remote host name of which ongoing receiving to be canceled (Optional)

Specify this parameter as an alphanumeric character string of 68 bytes or less.

If omitted, receiving-side transferring instances for all target IDs will be canceled.

TRID=transfer-id

Transfer ID of the ongoing or waiting receiving-side transferring instance to cancel (Optional)

Specify this parameter as an alphanumeric character string of 64 bytes.

If omitted, all receiving-side transferring instances for file IDs and hosts specified with "F=" and "H=" will be canceled.

G

Control of error messages that the Receive Cancel command outputs (Optional)

When omitted, HULFT displays error messages.

OUTPUT=filename

Destination of the error messages that the Receive Cancel command outputs (Optional)

Specify this parameter in the format of Library name/File name(Member name).

When omitted, error messages are not output.

The number of log records that a log file can retain is unlimited.

EXIT CL variable name

Specifies to receive the error code output by the Receive Cancel command and specifies the CL variable name to set the error code value (Optional)

The CL variable name must immediately follow the EXIT tag.

HULFT sets an error code to the CL variable only if the command ends unsuccessfully.

When omitted, an error code is not set.

Note

  • If the same Host Name and the same File IDs exist, all the corresponding receiving-side transferring instances are canceled.

  • The Post-receive Job that is specified in the canceled receiving does not start.

  • Even if the request from the command was received successfully upon canceling the receiving, it may take some time until the actual cancelation takes effect in the following cases:

    • Too wide Transfer Interval configured on the sending host

    • Where the sending host has been waiting for response from remote hosts

  • You cannot cancel the receiving if the Post-receive Job has already started.

Command interface

UTLRCAN FILEID( ) HOSTNAME( ) TRID( ) LIBRARY( ) MSG( ) FILE( ) MBR( )

Explanation of parameters

FILEID

File ID of which receiving to be canceled (Optional)

Specify a string of alphanumeric characters (and "_" if desired) that is within 50 bytes.

To cancel all instant transfers at the same time, specify "_INSTANT_TRANSFER_".

To cancel an individual instant transfer, specify with "TRID=".

If omitted, receiving-side transferring instances for all target hosts will be canceled.

HOSTNAME

Remote host name of which ongoing receiving to be canceled (Optional)

Specify this parameter as an alphanumeric character string of 68 bytes or less.

If omitted, receiving-side transferring instances for all target IDs will be canceled.

TRID

Transfer ID of the ongoing or waiting receiving-side transferring instance to cancel (Optional)

Specify this parameter as an alphanumeric character string of 64 bytes.

If omitted, all receiving-side transferring instances for file IDs and hosts specified with "FILEID" and "HOSTNAME" will be canceled.

LIBRARY

Library name in which HULFT is installed ("HULFT" by default)

Specify this parameter as an alphanumeric character string of 10 bytes or less starting with an alphabet.

MSG

Control of error messages ("*YES" by default)

*NO :

Suppress error messages.

*YES :

Show error messages.

FILE

Name of the library and the file to which error messages are output (Optional)

Specify this parameter in the format of Library name/File name.

Specify these names as an alphanumeric character string of 10 bytes or less starting with an alphabet, respectively.

When omitted, error messages are not output. The number of log records that a log file can retain is unlimited.

MBR

Member name of the file to which error messages are output ("*FILE" by default)

Specify this parameter as an alphanumeric character string of 10 bytes or less starting with an alphabet.