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

fts_ftp_event_ex() - obtain the transmission-end results

Format

#include <apihead.h>
#include <winsock.h>
 
BOOL  fts_ftp_event_ex( SOCKET sock, FTS_FTP_API_RETDATA_EX *retdata )

Function

This function obtains the termination results of a transmission that was registered by fts_ftp_asyn_request_ex().

You can determine whether the transmission was successful by checking the trans_status member of the transmission-end information structure.

Arguments

sock

Specifies the return value of fts_ftp_open().

retdata

Specifies the address of a transmission-end information structure. It returns the termination result of transmission.

Notes

Call this function after you have called fts_ftp_open().

If transmission is not finished when this function is issued, the function waits until the transmission is finished.

If you wish to obtain the extended error information, do not call any function before you call the WSAGetLastError function. If you call another function before the WSAGetLastError function, the information might be lost.

Return values

TRUE Normal

FALSE Abnormal.
Acquisition of transmission-end information failed.

To obtain extended error information, call the WSAGetLastError function. The table below lists and describes the return values for the extended error information. For details about other errors, see the winsock documentation.

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

FTS_API_ERROR_NOTSTARTUP
(0x2FFFFF00, 8053306112) WSAStartup() has not been called. No

FTS_API_ERROR_DISCONNECT
(0x2FFFFF05, 8053306117) A connection with the JP1/File Transmission Server/FTP Client service was released. If you want to register the transmission request again, you must start the process over from ftp_ftp_open(). No

FTS_API_ERROR_BADFORMAT
(0x2FFFFF07, 8053306119) An address with an invalid data type was specified in an argument. No

FTS_API_ERROR_NODATA
(0x2FFFFF09, 8053306121) There is no registered transmission request. No

FTS_API_ERROR_NOTSOCK
(0x2FFFFF0D, 8053306125) The return value of fts_ftp_open() might not have been set in the first argument. No

FTS_API_ERROR_LOGIC
(0x2FFFFF10, 8053306128) A logical conflict error occurred in API. No

Return value of extended error information (hexadecimal, decimal)	Description	Can be retried?
FTS_API_ERROR_NOTSTARTUP (0x2FFFFF00, 8053306112)	WSAStartup() has not been called.	No
FTS_API_ERROR_DISCONNECT (0x2FFFFF05, 8053306117)	A connection with the JP1/File Transmission Server/FTP Client service was released. If you want to register the transmission request again, you must start the process over from ftp_ftp_open().	No
FTS_API_ERROR_BADFORMAT (0x2FFFFF07, 8053306119)	An address with an invalid data type was specified in an argument.	No
FTS_API_ERROR_NODATA (0x2FFFFF09, 8053306121)	There is no registered transmission request.	No
FTS_API_ERROR_NOTSOCK (0x2FFFFF0D, 8053306125)	The return value of fts_ftp_open() might not have been set in the first argument.	No
FTS_API_ERROR_LOGIC (0x2FFFFF10, 8053306128)	A logical conflict error occurred in API.	No

[Contents][Back][Next]

[Trademarks]

TRUE	Normal
FALSE	Abnormal. Acquisition of transmission-end information failed.