ft_reqlist() determines the request IDs of requests for asynchronous file transfer which have not yet been terminated with the function ft_reqterm().
If the list parameter has the value NULL
or if the listlen parameter has the value 0, you only receive the number of requests that have not yet been completed when you use ft_reqterm().
The request from all sessions assigned with the function ft_open to the same working directory that applies as the current session are listed.
Syntax
#include <ftapi.h> int ft_reqlist(const void *session, /* input */ long *list, int listlen, /* input */ struct ft_err *errorinfo, void *options); /* input */
Parameter
session
Session ID of the session for which non-terminated asynchronous file Transfer request is to be determined.
list
Area in which the request IDs of non-terminated requests for asynchronous file transfer are stored. The length of this area (number of entries) must be stored in listlen.
If list is NULL
, only the number (not the request IDs) of non-terminated requests is determined.
listlen
Number of entries in list.
If listlen is 0, only the number (not the request IDs) of non-terminated requests is determined.
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
n | Number of entries found (n >= 0). |
-1 | Error. The error type is stored in errorinfo. |