DefineTransferTemplate
method
Programming with Reflection
DefineTransferTemplate
method
Syntax object.DefineTransferTemplate HostSystem, PCFilename, HostFilename, TransferType, ExistsAction, Recfm, AsciiCRLF, BinaryCRLF, JISCIICRLF, LRECL, AddParm, BlockSize, AllocUnits, AvgBlkSize, PrimAlloc, SecAlloc
Creates a file transfer template. File transfer templates define a set of conditions that affect how Reflection handles files transferred between your PC and a host.
HostSystem Argument Type: Enumeration
Specifies which 3270 operating environment the host is running. The possible
values are:
rcCICS The host is running CICS.
rcCMS The host is running CMS.
rcTSO The host is running TSO.
PCFilename Argument type: String
Specifies the PC file name parameters for files transferred to and from
the host with this template. Use * as a wildcard character. For example:
"*.txt"
HostFileName Argument type: String
Specifies the PC file name parameters for files transferred to and from
the host with this template. Use * as a wildcard character. For example:
"bin.*"
TransferType Argument Type: Enumeration
Specifies the transfer method.
rcASCII Use this value for text files with no special formatting. ASCII files are translated to the EBCDIC character set during transfer to the host.
rcBinary Use this value for program files and for other types of files that should not be translated.
rcJISCII Use this value only if you are transferring files that contain Japanese double-byte characters with no special formatting.
ExistsAction Argument Type: Enumeration
Specifies what Reflection should do if it finds a file with the same file
specification as the file you are trying to create. The possible values
are:
rcAppend Appends the transferred file to the existing file.
rcAskUser Prompts you for a decision in this situation. Note: This option is not supported by the Write Structured Field protocol and will force a transfer with the Buffered protocol.
rcOpenError Causes the transfer to fail (return an error) when the host file already exists. Note: This option is not supported by the Write Structured Field protocol and will force a transfer with the Buffered protocol.
rcOverwrite Replaces the existing host file. With CICS systems there is no way to tell if a host file already exists, so this option is the only available option for sending files to a CICS system.
Recfm Argument Type: Enumeration
Specifies the record format for files sent to the host. The possible values
are:
rcFixed Forces the host to create fixed-length records.
rcUndefined Forces the host to create files without a specific record format (this value is only relevant for TSO systems).
rcVariable Forces the host to create variable-length records and preserves the format of a binary file.
rcXfrRecFmDflt The host determines the record format.
AsciiCRLF Argument Type: Enumeration
Specifies whether carriage return/line feed characters are stripped from
the end of each line of any ASCII file being sent. Typically, rcConvert
is appropriate for this argument.
rcConvert Carriage return/line feed characters are stripped.
rcIgnore Carriage return/line feed characters are not stripped.
BinaryCRLF Argument Type: Enumeration
Specifies whether carriage return/line feed characters are stripped from
the end of each line of any binary file being sent. Typically, rcIgnore
is appropriate for this argument.
rcConvert Carriage return/line feed characters are stripped.
rcIgnore Carriage return/line feed characters are not stripped.
JISCIICRLF Argument Type: Enumeration
Specifies whether carriage return/line feed characters are stripped from
the end of each line of any JISCII file being sent. This argument is only
relevant for Japanese double-byte transfers. Typically, rcConvert is appropriate
for this argument.
rcConvert Carriage return/line feed characters are stripped.
rcIgnore Carriage return/line feed characters are not stripped.
LRECL Argument Type: Integer
or Enumeration
Specifies the record size (in bytes) for the file being created on the
host. The range of values is 0 - 32768. Use rcDefaultLrecl to have the
record size be determined by the host.
AddParm Argument type: String
Use this argument for any parameters specific to the IND$FILE program on
your host system. This string is appended to the end of the transfer command
generated by Reflection. Reflection does not check this string for validity.
BlockSize Argument Type: Integer
or Enumeration
Specifies the block size (in bytes) for the file being created on the host.
For files with fixed-length records, this value must be a multiple of
the Logical record length (because blocks are divided into logical records).
Reflection lets you set any value between 0 and 32768, to accommodate
any range accepted by your host. Use rcDefaultBlkSize to specify the host
default. This value is only relevant for TSO transfers.
AllocUnits Argument Type: Enumeration
Specifies the allocation units for your primary and secondary space allocations.
This argument is only relevant for TSO transfers.
rcXfrAllocBlock Use blocks. Use AvgBlkSize to specify the size for an average block.
rrcXfrAllocCylinder Use cylinders.
rcXfrAllocDflt The allocation unit is determined by the host.
rcXfrAllocTrack Use tracks.
AvgBlkSize Argument Type: Integer
or Enumeration
Specifies the size (in bytes) for an average block. Reflection lets you
set any value between 0 and 32768, to accommodate any range accepted by
your host. Use rcDefaultAvgBlk to specify the host default. This value
is only relevant for TSO transfers when AllocUnits is rcXfrAllocBlock.
PrimAlloc Argument Type: Integer
or Enumeration
Specifies the size (in allocation units) of the primary allocation for
the host file being created. Reflection lets you set any value between
0 and 32768, to accommodate any range accepted by your host. Use rcDefaultPrimAlloc
to specify the host default. This argument is only relevant for TSO transfers.
SecAlloc Argument type: Integer
or Enumeration
Specifies the size of any additional allocations (in allocation units)
in the event that the primary allocation is not sufficient. Multiple secondary
allocations (known as "extents") are allowed, up to a host-specified
limit (generally 15). Reflection lets you set any value between 0 and
32768, to accommodate any range accepted by your host. Use rcDefaultSecAlloc
to specify the host default. This argument is only relevant for TSO transfers.
Related
Topics