The fxfer.h and fxfer.inc header files have the fxc structure in common. This structure defines options used by both the C and Pascal header file.
The options in the C structures
and Pascal record declarations for the File Transfer Program Interface
|f_logonid||Contains the host login ID string. This value should contain the
host login ID, the AUTOLOG node ID, and two optional AUTOLOG parameters, all
separated by commas. This list is passed to the automatic login
At run time, the operator is asked to enter a password. The host login session is maintained for subsequent file transfers, eliminating the need to log in again. The file transfer wait period in the HCON session profile variable determines the length of time the login session is maintained.
|f_inputfld||Specifies a host input field. This option enables the user to place host file transfer program (IND$FILE) options on the host file-transfer program command line. It also allows the user to place comments within the command. This option is valid only for CICS and VSE hosts.|
|f_aix_codepg||Specifies an alternate code set to use for an ASCII-to-EBCDIC or EBCDIC-to-ASCII translation. If this field is null, the ASCII code set is extracted from the system locale.|
|FXC_APPND||Appends the file specified by the source file to the destination file if the destination file exists when the FXC_APPND flag is set in the fxc_opts.f_flags field. This option is ignored if the destination file does not exist. This option is not valid when uploading to a CICS or VSE host.|
|FXC_CICS||Specifies the host as CICS/VS when the FXC_CICS flag is set. The user must specify the correct host operating system. The file-transfer program does not distinguish between the four host operating systems.|
|FXC_CMS||Specifies the host as VM/CMS when the FXC_CMS flag is set in the fxc_opts.f_flags field. The user must specify the correct host operating system. The file-transfer program does not distinguish between the four host operating systems.|
|FXC_DOWN||Downloads the file from a host file to a file when the FXC_DOWN flag is set in the fxc_opts.f_flags field.|
|FXC_QUEUE||Executes the file transfer asynchronously as a background process when set in the fxc_opts.f_flags field. If any file transfers have not completed, the current transfer request is queued. If this option is not specified, the file-transfer operation is synchronous.|
|FXC_REPL||Replaces an existing file on the host (upload) or replaces an existing file (download) when the FXC_REPL flag is set in the fxc_opts.f_flags field. When uploading to a CICS host, this option is the default.|
|FXC_TSO||Specifies the host as MVS/TSO (Multiple Virtual Storage/Time Sharing Option) when set in the fxc_opts.f_flags field. The user must specify the correct host operating system. The file-transfer program does not distinguish between the four host operating systems.|
|FXC_TNL||Translates EBCDIC to ASCII when downloading files, if set in the fxc_opts.f_flags field. During uploading, the FXC_TNL option translates ASCII to EBCDIC. This option assumes the file is a text file and is used when transferring formatted text files. The default is no translation. The new-line character is the line delimiter.|
|FXC_TCRLF||Performs the same function as the FXC_TNL option when set in
the fxc_opts.f_flags field, except that the line delimiter
is the carriage return/line-feed (CR-LF) character sequence. This
option is used to translate PC-DOS files. A PC-DOS end-of-file
character is inserted at the end of the downloaded file.
Note: If neither the FXC_TNL nor the FXC_TCRLF option is specified, the file transfer assumes no translation and transfers the data in binary form. When transferring a binary file to the host, the host file-transfer program defaults the host file to a fixed record format. If the user wishes not to have the host file padded with blanks at the end, the FXC_VAR option should be specified to delineate a variable record format.
|FXC_UP||Uploads the file from the operating system file to the host file when set in the fxc_opts.f_flags field.|
|FXC_VSE||Specifies the host as VSE/ESA (Virtual Storage Extended/Enterprise Systems Architecture) or VSE/SP (VSE/System Product) when set in the fxc_opts.f_flags field. The user must specify the correct host operating system. The file transfer program does not distinguish between the four operating systems.|
The following flags specify host
file characteristics. They can be used only to upload files, with the
exception of the FXC_FIXED option, which can be used when
downloading from a VSE host.
|f_blksize||Specifies the nonzero block size of the host data set. This option is only used in the MVS/TSO environment. For new files, the default is the logical record length. This flag is ignored if the file is being appended.|
|f_lrecl||Specifies the nonzero logical record length of the host file. For new files, the default is 80. For variable-length records, the f_lrecl field is the maximum size of the record. This field is ignored if the file is being appended. If using this option while uploading to a CICS or VSE host, the FXC_FIXED option flag must also be specified.|
|FXC_FIXED||Specifies fixed-length records when set in the fxc_opts.f_flags field. This is the default if none of the following flags are set: FXC_VAR, FXC_TNL, and FXC_TCRLF. This flag is ignored if the file is being appended. If specifying this option while uploading to a CICS or VSE host, either the FXC_TNL or the FXC_TCRLF option flag must be specified. If this option is specified when downloading from a VSE host, all trailing blanks are downloaded. The default option when downloading a translatable file from a VSE host causes all trailing blanks to be deleted.|
|FXC_UNDEF||Specifies records of undefined length when set in the fxc_opts.f_flags field. This option can only be used in the MVS/TSO environment and is ignored if the file is being appended.|
|FXC_VAR||Specifies variable-length records when set in the fxc_opts.f_flags field. This is the default if the FXC_FIXED flag is not set and either the FXC_TNL or the FXC_TCRLF flag is set. This flag is ignored if the file is being appended.|
|s_space||Specifies the non-zero number of units of space to be allocated for a new data set. This option can only be used in the MVS/TSO environment. The s_space field has the following optional subfields:|
|s_increment||Specifies the number of units of space to be added to the data set each time the previously allocated space is filled.|
|s_unit||Specifies the unit of space. A value of FXC_TRACKS indicates the unit of allocation is tracks. A value of FXC_CYLINDERS indicates the unit of allocation is cylinders. Otherwise, the s_space field specifies the average block size (in bytes) of the records to be written to the data set. If the s_space field has a value of zero, the default unit of allocation is the value specified by the f_blksize field. If the f_blksize field is not specified, the host file-transfer program uses the default value of 80.|
The cfxfer function, fxfer function, g32_fxfer function.
The fxfer command.