Transfer services

Call syntax

CALL     "CFTU"     USING     <verb>       <param>     <rc>
CALL     "CFTC"     USING     <verb>       <param>     <rc>

Where:

  • CFTU indicates that syntax analysis is requested
    CFTC indicates that syntax analysis is not requested
  • <verb> is the command that you want to process
  • <param> is a character string of variable length that contains the command parameters. The end of the field is defined by a character initially set to low-value
  • <rc> is the return code

The available <verbs> are listed in the following table.

<verb>

Value

Service

F-SEND

SEND

Send

F-RECV

RECV

Receive

F-HALT

HALT

Interrupt

F-KEEP

KEEP

Suspend

F-START

START

Retry

F-DELETE

DELETE

Delete

F-END

END

Proceed to "X" state

F-SUBMIT

SUBMIT

Re-submit end-of-transfer procedure

F-SHUT

SHUT

Stop monitor

F-SWITCH

SWITCH

Switching monitoring files
(log, statistics file)

F-CLOSEAPI

CLOSEAPI

Freeing resources allocated at the opening of the communication medium

For more details on the parameter syntax for each command, refer to the Command index.

If <param> is not defined, CFTU takes the default name.

As these media are not available on all systems, an availability check is performed by the function.

Return codes

Mnemonic

Description

CAPI-NOERR

No error

CAPI-FUNC-UNDEF

Command not valid

CAPI-CMD-LENGTH

Transfer CFT command string invalid, does not exist, or greater than 1024 characters long 

CAPI-KEY-NAME

Command syntax incorrect: keyword name incorrect

CAPI-KEY-VALUE

Command syntax incorrect: keyword value incorrect

CAPI-MEM-GET

Memory allocation error

CAPI-MEM-FREE

Memory de-allocation error

CAPI-INT-ERR1

Internal error 1

CAPI-INT-ERR2

Internal error 2

CAPI-INT-ERR3

Internal error 3

Error messages

The FIELD and MSG fields of the CFTAPI COPY CLAUSE contain:

  • FIELD: name of the incorrect parameter detected by the Transfer CFT syntax analyzer
  • MSG:
  • Either a message relative to the error recognized by the syntax analyzer
  • Or an error message describing an incident when the command is taken into account

See Messages and error codes .

If no error is detected, the FIELD and MSG fields are blank.

Related Links