Hitachi

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


fts_ftp_cancel() - cancel transmission

Organization of this page

Format

#include <winsock2.h>
#include <apihead.h>
 
BOOL  fts_ftp_cancel( int cs_flag, unsigned long trno )

Function

This function cancels the transmission (server or client) that is underway.

A canceled transmission terminates abnormally.

Arguments

cs_flag

Specifies the service type of the transmission that you wish to cancel.

If you specify FTS_CAN_SERVER, the function cancels the server's transmission.

If you specify FTS_CAN_CLIENT, the function cancels the client's transmission.

If you OR the two values, the function cancels both the server's and the client's transmissions.

trno

Specifies the transmission number of the transmission that you wish to cancel.

If you specify FTS_CAN_ALL, the function cancels all transmissions for the specified service.

Note

This function does not require connection establishment with JP1/FTP.

Return values

TRUE

Normal

FALSE

Abnormal.

Cancellation of transmission 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_LOGIC

(0x2FFFFF10, 805306128)

A logical conflict error occurred in API.

No

FTS_API_ERROR_T_NOT_FOUND

(0x2FFFFF11, 805306129)

The specified transmission is not executing.

No

FTS_API_ERROR_ARGUMENT

(0x2FFFFF12, 805306130)

An invalid argument value was specified.

No