Send Request API

This API issues the Send Request for the specified file ID. Since the API works in Language Environment (LE), the CEE.SCEERUN Language Environment library is required. (This is the default name if the library name is defaulted during the installation of the operating system.)

= Remarks =

This API does not support use of the Send Request in the Synchronous Transfer mode.

(1) Call Format (COBOL)

CALL 'XRRCVAP' USING parameter area

Explanation of parameter area

Field

Attribute

Length

Input/Output

Description

Operating Version

Character

6

Input

Specify the version of the parameter area.

Specify one of the following:

  • V08L01

  • V08L02

  • V08L04

The operation is the same regardless of which you specify.

Receive File ID

Character

50

Input

Specify the file ID for the Send Request.

Reserved

Character

8

 

 

Status Code

Binary

2

Output

The API sets the status code in this field when the API ends.

Detail Code

Binary

2

Output

The API sets the detail code in this field when the API ends.

(2) Status Codes

Status Code

Description

0

The API executed the Send Request successfully.

1

Failed to open the Send and Receive Management file (HULFT.FILE).

2

The Receive Management Information for the applicable file ID does not exist.

3

Failed to acquire the records of the Send and Receive Management Information.

4

The record of the Transfer Group Information that is specified in the Send and Receive Management Information does not exist.

5

Failed to acquire the records of the Transfer Group Information.

6

Failed to acquire the records of the Host Information.

7

Failed to connect to Communications Server. A communication error code is set in the Detail Code. For details, refer to the communication error code list in Error Codes and Messages.

8

Failed to connect to the remote host. A communication error code is set in the Detail Code. For details, refer to the communication error code list in Error Codes and Messages.

9

Failed to communicate with the remote host. The status code of the remote host is set in the Detail Code. For details, refer to Error Codes and Messages for the remote host.

10

Request for connection to the remote host failed. A communication error code is set in the Detail Code. For details, refer to the communication error code list in Error Codes and Messages.

11

A version inconsistency occurred in the connection to the destination product. Check the supported version.

12

The operating version is not supported.

13

A function that cannot be used with the version of HULFT at the communication destination is specified.

  • A string whose length is 9 bytes or more is specified for the File ID.
Note

Incorporate the following DD statements into the JCL to be executed:

  • Example of JCL

    • //XRFILE   DD DSN=HULFT.FILE,DISP=SHR                                           
//XRHOST   DD DSN=HULFT.HOST,DISP=SHR                                           
//XRSYSIN  DD DSN=HULFT.PARMLIB(HULPRM),DISP=SHR                                
//IPGET    DD DSN=HULFT.HOSTS.LOCAL,DISP=SHR                                    
//*SYSTCPD DD DSN=TCPIVP.TCPPARMS(TCPDATA),DISP=SHR

    DD Name

    Value

    Description

    XRFILE

    HULFT.FILE

    Send and Receive Management File

    XRHOST

    HULFT.HOST

    Host Information File

    XRSYSIN

    HULFT.PARMLIB(HULPRM)

    System Environment Settings File

    IPGET

    HULFT.HOSTS.LOCAL

    IP Management File

    SYSTCPD

    TCPIVP.TCPPARMS(TCPDATA)

    TCPIP.DATA Data Set

(3) Example of Use

Case where you use COBOL

Below is a sample program that executes the Send Request, using the Send Request API (XRRCVAP).

The sample program has member name 'SMPRCVAP' in HULFT JCL library.

Data to be used

The file ID of the record of the Send Management Information:

FILEID

      * 
      * HULFT SEND REQUEST API SAMPLE 
      * 
       IDENTIFICATION     DIVISION. 
       PROGRAM-ID.         SMPRCVAP. 
       ENVIRONMENT        DIVISION. 
       DATA               DIVISION. 
       WORKING-STORAGE    SECTION. 
      * 
      * XRRCVAP PARAMETER AREA 
      * 
       01  XRRCVAP-PARM. 
           02 XRRCVAP-VER      PIC X(6). 
           02 XRRCVAP-FILEID   PIC X(50). 
           02 XRRCVAP-RESERVE  PIC X(8). 
           02 XRRCVAP-RTNCD    PIC 9(4)  COMP. 
           02 XRRCVAP-ERRCD    PIC 9(4)  COMP. 
      *------------------------------------------------* 
       PROCEDURE          DIVISION. 
      * 
      * XRRCVAP PARAMETER AREA INITIALIZATION 
      * 
           INITIALIZE    XRRCVAP-PARM. 
      * 
      * ISSUE REQUEST FOR SEND REQUEST 
      * 
           MOVE 'V08L04'       TO XRRCVAP-VER. 
           MOVE 'FILEID'       TO XRRCVAP-FILEID. 
           CALL 'XRRCVAP' USING XRRCVAP-PARM. 
      * 
           STOP RUN.