Purpose

Returns the contents of the full FCAI_Map structure.

Parameters

stem

The name of a stem that represents the FTP client environment. The stem must have been passed on a prior successful INIT function call.

'get_fcai_map'

Requests the return of the full FCAI_Map structure. The string literal is not case sensitive.

fcaimap

The name of the stem where the FCAI_Map structure should be placed. The map elements shown in Table 1 can be returned.

Table 1. FCAI_Map structure elements

Element	Description
fcaiMap.FCAI_EyeCatcher	Eyecatcher='FCAI'
fcaiMap.FCAI_Size	Size of the FCAI=256
fcaiMap.FCAI_Version	Version of the FCAI=1
fcaiMap.FCAI_PollWait	POLL wait timer in seconds
fcaiMap.FCAI_ReqTimer	Request timer in seconds or 0 for none
fcaiMap.FCAI_TraceIt	Trace indicator for this request
fcaiMap.FCAI_TraceID	ID used in a trace record
fcaiMap.FCAI_TraceCAPI	TRACECAPI value on FTP.DATA statement
fcaiMap.FCAI_TraceStatus	Status of the trace
fcaiMap.FCAI_TraceSClass	SYSOUT class for trace file
fcaiMap.FCAI_TraceName	ddname of the trace file
fcaiMap.FCAI_Token	Interface token
fcaiMap.FCAI_RequestID	Last request processed by the EZAFTPKS program (for example, 'SCMD')
fcaiMap.FCAI_Result	Request result
fcaiMap.FCAI_IE	Interface error
fcaiMap.FCAI_CEC	Client error code (see FTP return codes in z/OS Communications Server: IP User's Guide and Commands)
fcaiMap.FCAI_ReplyCode	Server reply code or 0 if no reply (see FTPD reply codes in z/OS Communications Server: IP and SNA Codes)
fcaiMap.FCAI_SCMD	Subcommand code (see FTP subcommand codes in z/OS Communications Server: IP User's Guide and Commands)
fcaiMap.FCAI_ReturnCode	Return code
fcaiMap.FCAI_ReasonCode	Reason code
fcaiMap.FCAI_NumberLines	Number of output lines returned by the request
fcaiMap.FCAI_LongestLine	Size of the longest line
fcaiMap.FCAI_SizeAll	Size of all output lines
fcaiMap.FCAI_SizeMessages	Size of all message lines
fcaiMap.FCAI_SizeReplies	Size of all reply lines
fcaiMap.FCAI_SizeList	Size of all list lines
fcaiMap.FCAI_SizeTrace	Size of all trace lines
fcaiMap.FCAI_PID	Process ID of FTP client

Results