ft_cancel() cancels asynchronous requests which are in the course of being processed or which are waiting to be processed in the queue.
Syntax
#include <ftapi.h>
int ft_cancel(const void *session, /* input */
long rid, /* input */
struct ft_err *errorinfo,
void *options); /* input */
Parameters
session
Session number in which the request is to be canceled.
rid
ID of the request to be canceled.
If the request to be canceled was issued in a different session, the current session must be assigned the same working directory as the one in which the request was issued.
Furthermore, the program in which the asynchronous request is cancelled must be running under the same login name as the one in which the request was issued.
errorinfo
Area in which detailed information is stored if an error is encountered (see section “ft_err” (Error handling)).
The specification of this parameter is optional. If you do not require any more precise error information then you can specify the value NULL for errorinfo.
options
The specification of the options parameter is optional. If the value NULL is specified then message activity at the program interface is compatible with that of the program interface of openFT < V10.
Alternatively, it is possible to specify the ft_options structure (see section “ft_options” (Version of the program interface)) to activate the openFT message number scheme as of openFT V10 and the extensions to the function.
Return value
0 | No error. |
-1 | Error. The error type is stored in errorinfo. |