fxfer Function

Purpose

Initiates a file transfer from within a program.

Library

File Transfer Library (libfxfer.a)

C Syntax

#include <fxfer.h>

fxfer (xfer, sessionname)

struct fxc *xfer;

char *sessionname;

Pascal Syntax

%include /usr/include/fxfer.inc

%include /usr/include/fxhfile.inc

%include /usr/include/fxconst.inc

function pfxfer
(var xfer : fxc; sessionname : stringptr) :
integer; external;

FORTRAN Syntax

INTEGER FFXFER

EXTERNAL FFXFER

CHARACTER*XX SRCF, DSTF, LOGID, INPUTFLD, CODESET, SESSIONNAME

INT FLAGS, RECL, BLKSIZE, SPACE, INCR, UNIT, RC

RC = FFXFER (SRCF, DSTF, LOGID, FLAGS, RECL, BLKSIZE,

+ SPACE, INCR, UNIT, INPUTFLD, CODESET, SESSIONNAME)

Description

The fxfer function transfers a file from a specified source to a specified destination. The file transfer is accomplished as follows:

• In the C or Pascal language, the fxfer or pfxfer function transfers a file specified by the fxc_src variable to the file specified by the fxc_dst variable. Both variables are defined in the fxc structure.
• In the FORTRAN language, the FFXFER function transfers a file specified by the SRCF variable to the file specified by the DSTF variable.

The file names are character strings. The local-system file names must be in operating system format. The host file names must conform to the host naming convention, which must be one of the following formats:

C Parameters

Pascal Parameters

FORTRAN Parameters

Notes:

1. All FORTRAN character array strings must be terminated by a null character, as in the following example:

   SRCF = 'rtfile'//CHAR(0)

2. The VSE host system is not supported in a DBCS environment.
3. The unique DBCS file-transfer flags are not supported by this function.

Return Values

If the fxfer function is called synchronously, it returns a value of 0 when the transfer is completed. The application program can then issue a cfxfer function call to obtain the status of the file transfer.

If the fxfer function is called asynchronously, it returns 0. The application program can issue a cfxfer function call to determine when the file transfer is completed and to obtain the status of the file transfer. If the status cannot be reported by the cfxfer function due to an I/O error on the fx_statxxxxxx status file, the cfxfer function returns a -1. If the status is not ready, the cfxfer function returns a -2.

The fx_statxxxxxx status file contains the status of each file transfer request made by the application program. The fxfer function fills in the xxxxxx portion of the fx_stat file based on random letter generation and places the file in the $HOME directory.

Implementation Specifics

The fxfer function is part of the Host Connection Program (HCON).

The fxfer function requires one or more adapters used to connect to a host.

This function requires one of the following operating system environments be installed on the mainframe host: VM/SP CMS, VM/XA CMS, MVS/SP TSO/E, MVS/XA, TSO/E, CICS/VS, VSE/ESA, or VSE/SP.

This function requires that the System/370 Host-Supported File Transfer Program (IND$FILE or its equivalent) be installed on the mainframe host.

Files

Related Information

The file-transfer check status function is the cfxfer function.