Send File (90)

Top  Previous  Next

The Send File function is used to transfer a file from the workstation session where EHLLAPI is running to a host session.

 

3270

5250

Yes

Yes

 

 

Prerequisite Calls

 

There are no prerequisite calls for this function.

 

 

Call Parameters

 

 

Standard Interface

Enhanced Interface

Function Number

Must be 90.

 

Data String

Refer to the examples.

 

Length

Length of the target data string. Overridden in EOT mode.

 

PS Position

Must be 0.

 

 

Following are examples of the data strings for SBCS

 

3270 Session

 

To send the file to the VM/CMS host system:

 

pc_filename [id:]fn ft [fm] [(option]

 

To send the file to the MVS/TSO host system:

 

pc_filename [id:]dataset[(member)] [/password] [option]

 

To send the file to the CICS host system:

 

pc_filename [id:]host_filename [(option]

 

5259 Session

 

To send the file to the eServer i5 or iSeries host system:

 

pc_filename [id:]library file member [option]

 

Following are examples of the data strings for DBCS:

 

3270 Session

 

To send the file to the VM/CMS host system:

 

pc_filename [id:]fn ft [fm] [(option]

 

To send the file to the MVS/TSO host system:

 

pc_filename [id:]dataset[(member)] [/password]  [(option]

 

To send the file to the CICS host system:

 

pc_filename [id:]host_filename [(option]

 

5250 Session

 

To send the file to the eServer i5 or iSeries host system:

 

pc_filename [id:]library file member [option]

 

Note:

Parameters within [ ] are optional. Available options are listed below.

 

Host System

Common Options

VM/CMS

ASCII, JISCII, CRLF, APPEND, LRECL n, RECFM v|f, TIME n, CLEAR, NOCLEAR, PROGRESS, QUIET

MVS/TSO

ASCII, JISCII, CRLF, APPEND, LRECL (n), RECFM (v|f|u), TIME (n), CLEAR, NOCLEAR, PROGRESS, QUIET, BLKSIZE (n), SPACE (n[,m]), AVBLOCK|TRACKS|CYLINDERS

CICS

ASCII, JISCII, CRLF, BINARY, TIME n, CLEAR, NOCLEAR, PROGRESS, QUIET

i5/OS or OS/400

ASCII, JISCII, CRLF, APPEND, SRC, LRECL n, TIME n, CLEAR, NOCLEAR, PROGRESS, QUIET

 

Note:  JISCII is valid in a DBCS session for Japan only and ASCII is valid for all other SBCS and DBCS sessions.  Note:  Time, if specified, overrides the value in Set Session parameters.  Note:  Other options specified will be passed to the host transfer program. The file transfer program on the host side either uses them, ignores them, or returns an error. Consult the host transfer program documentation to see a complete list of the options supported.                

 

 

Return Parameters

 

Return Code

Explanation

2

Parameter error or you have specified a length that is too long (more than 255 bytes) for the EHLLAPI buffer. The file transfer was unsuccessful.

3

File transfer complete.

4

File transfer complete with segmented records.

5

Workstation file name is not valid or not found. File transfer was canceled.

9

A system error was encountered.

27

File transfer terminated because of either a Cancel button or the timeout set by the Set Session Parameter (9) function.

101

File transfer was successful (transfer to/from CICS).

 

If you receive return code 2 or 9, there is a problem with the system or with the way you specified your data string.

 

Other return codes can also be received which relate to message numbers generated by the host transfer program. For transfers to a CICS host transfer program, subtract 100 from the return code to give you the numeric portion of the message. For example, a return code of 101 would mean that the message number INW0001 was issued by the host. For other host transfer programs, just use the return code as the numerical part of the message. For example, a return of 34 would mean that message TRANS34 was issued by the host transfer program. The documentation for your host transfer program should give more information about the meanings of the specific messages.

 

Operating system error codes reported by EHLLAPI are greater than 300. To determine the error code, subtract 300 and refer to the operating system documentation for return codes.

 

 

Remarks

 

Four sets of parameters under the Set Session Parameters (9) function are related to this function. They are the QUIET/NOQUIET, STRLEN/STREOT, TIMEOUT=c/TIMEOUT=0, and the EOT=c session options.