Job Management Partner 1/File Transmission Server/FTP Description, Reference and Operator's Guide

fts_ftp_asyn_request_ex() - register transmission requests (asynchronous)

Format

#include <apihead.h>
 
int  fts_ftp_asyn_request_ex( int sock, 
                     char *cardname, 
                     FTS_FTP_API_DATA_EX *data,
                     unsigned long *trno,
                     int get_return_flag )

Function

This function registers a transmission request to JP1/FTP, but does not wait for the transmission to terminate. You must use fts_ftp_event_ex()to obtain the termination result. You can define the transmission request by specifying a transmission information structure or the name of a registered transmission card. You can determine whether the transmission was successful by checking the trans_status member of the transmission-end information structure that is obtained by fts_ftp_event_ex().

Arguments

sock

Specifies the return value of fts_ftp_open().

cardname

Specifies the name of a registered transmission card. The file transmission request is registered in accordance with the information on the transmission card.

data

Specifies the address of a transmission information structure.

If NULL is specified in cardname, the file transmission request is registered according to the information specified in data.

If the name of a registered transmission card is specified in cardname, the information on the transmission card is registered. The registered transmission information is stored in the transmission information structure. You can use this transmission information structure again when you register another file transmission request.

trno

Specifies the address at which the transmission number is stored.

This matches the transmission number in the transmission-end information that is obtained from log information or by fts_ftp_event_ex().

get_return_flag

If you have specified FTS_GET_RETURN, you can obtain the transmission-end information by calling fts_ftp_event_ex().

If you have specified FTS_UNGET_RETURN, the transmission-end information cannot be obtained.

Notes

Call this function after you have called fts_ftp_open().

If you want to obtain transmission-end information, call fts_ftp_event_ex() with FTS_GET_RETURN specified in the fifth argument. In this case, make sure that you issue fts_ftp_event_ex(). If fts_ftp_event_ex() is not issued, you might not be able to release the system resources (memory) because the transmission-end information remains in the process that issued the function or in JP1/FTP.

Return values

TRUE Normal

FALSE Abnormal.
Registration of the transmission request failed.

A value indicating an error is set in fts_errno. The table below lists and describes the return values for error information. In the case of an error other than one listed below, the system function's error number is set. For details, see the displayed error number for the system function.

Return value of extended error information (decimal) Description Can be retried?

FTS_API_ERROR_DISCONNECT
(805306116) A connection with the JP1/FTP daemon was released. If you want to register the transmission request again, you must start the processing over from ftp_ftp_open(). No

FTS_API_ERROR_NOTREADCARD
(805306117) The specified card name cannot be referenced. The card might not have been registered correctly. No

FTS_API_ERROR_MAXPALTRANS
(805306119) The maximum number of transmissions that can be executed concurrently (maximum number of concurrent transmissions) has been reached. Register the transmission request after another transmission is finished. For details about the maximum number of concurrent transmissions, see ftsutil - changes and displays environment information in 6. Commands. Yes

FTS_API_ERROR_MEMORY
(805306122) Memory allocation failed. No

FTS_API_ERROR_NOTSOCK
(805306124) The return value of fts_ftp_open() might not have been set in the first argument. No

FTS_API_ERROR_FTSMISS
(805306125) An error occurred in the JP1/FTP daemon. No

FTS_API_ERROR_FORCEEND
(805306127) The JP1/FTP daemon was terminated forcibly. No

FTS_API_ERROR_LOGIC
(805306128) A logical conflict error occurred in API. No

FTS_API_ERROR_MAXGROUPS
(805306129) The maximum number of secondary groups has been reached. No

Return value of extended error information (decimal)	Description	Can be retried?
FTS_API_ERROR_DISCONNECT (805306116)	A connection with the JP1/FTP daemon was released. If you want to register the transmission request again, you must start the processing over from ftp_ftp_open().	No
FTS_API_ERROR_NOTREADCARD (805306117)	The specified card name cannot be referenced. The card might not have been registered correctly.	No
FTS_API_ERROR_MAXPALTRANS (805306119)	The maximum number of transmissions that can be executed concurrently (maximum number of concurrent transmissions) has been reached. Register the transmission request after another transmission is finished. For details about the maximum number of concurrent transmissions, see ftsutil - changes and displays environment information in 6. Commands.	Yes
FTS_API_ERROR_MEMORY (805306122)	Memory allocation failed.	No
FTS_API_ERROR_NOTSOCK (805306124)	The return value of fts_ftp_open() might not have been set in the first argument.	No
FTS_API_ERROR_FTSMISS (805306125)	An error occurred in the JP1/FTP daemon.	No
FTS_API_ERROR_FORCEEND (805306127)	The JP1/FTP daemon was terminated forcibly.	No
FTS_API_ERROR_LOGIC (805306128)	A logical conflict error occurred in API.	No
FTS_API_ERROR_MAXGROUPS (805306129)	The maximum number of secondary groups has been reached.	No

[Contents][Back][Next]

[Trademarks]

TRUE	Normal
FALSE	Abnormal. Registration of the transmission request failed.