Hitachi

JP1 Version 12 for Windows Systems JP1/File Transmission Server/FTP Description, Reference and Operator's Guide


fts_ftp_event_ex() - obtain the transmission-end results

Organization of this page

Format

#include <winsock2.h>
#include <apihead.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_ex().

retdata

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

Notes

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 MSDN 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. To register the transmission request again, you must issue fts_ftp_close() and start the process over from fts_ftp_open_ex().

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_ex() might not have been set in the first argument.

No

FTS_API_ERROR_LOGIC

(0x2FFFFF10, 8053306128)

A logical conflict error occurred in API.

No