ft_sdopen() starts the identification of the attributes of all the files in a directory in the remote system.
Directory names must not exceed the length specified in the field maxrfnsize of the ft_prop structure (see section “ft_properties - Determine properties of the program interface”).
Syntax
#include <ftapi.h> void *ft_sdopen(const struct ft_admission *admis, /* input */ struct ft_shwpar *par, struct ft_err *errorinfo void *options); /* input */
Parameters
admis
Specifications for the remote system (see section “ft_admission” (Specifications concerning the remote system)).
par
Specifications for the request which you declare in the structure ft_shwpar:
struct ft_shwpar { int shwparvers; /* input */ char *fn; /* input */ char *mgmtpasswd; /* input */ char *fud; /* input */ int fudlen; /* input */ };
The fields of the ft_shwpar structure have the following meaning:
shwparvers
Version of the data structure.
The value FT_SPARV1
or FT_SPARV2
must be entered for shwparvers.
fn
Name of the directory containing the files whose attributes are to be determined.
Absolute and relative path specifications are permitted. Relative path specifications refer to the user ID defined in the admission profile if the FTAC function is used, otherwise to the HOME directory, see "File transfer".
mgmtpasswd
Password for the directory if it is password-protected.
fud
Address of a data area for the so-called "Further Details" which can indicate a more detailed cause of error if errors occur.
If NULL
is specified then no more detailed error cause is output. The fud parameter is only available if shwparvers is set to the value FT_SPARV2
and the options parameter is specified when ft_showdir is called.
fudlen
Length of the data area for fud.
The fudlen parameter is only available if shwparvers is set to the value FT_SPARV2
and the options parameter is specified when ft_showdir is called.
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 mandatory. The construction of the ft_options structure is described in section “Version of the program interface”.
Return value
id | ID of the request. This must be specified for both ft_sdinfo() and ft_sdclose(). |
| Error. The error type is stored in errorinfo. |