Your Browser is not longer supported

Please use Google Chrome, Mozilla Firefox or Microsoft Edge to view the page correctly
Loading...

{{viewport.spaceProperty.prod}}

ft_properties - Determine properties of the program interface

&pagelevel(3)&pagelevel

You can use ft_properties() to determine the version of the program interface of openFT and version-specific system values. The values returned by the ft_properties() function allow to check whether your program has been created with the same or with a different version of the program interface.

Syntax

#include <ftapi.h>
int ft_properties(struct ft_prop *prop,
                  struct ft_err *errorinfo);

Parameter

prop

Area in which the version of the openFT program interface used is stored, along with the valid system values. For this purpose, the structure ft_prop is used:


struct ft_prop
{
   int   ftpropvers;        /* input */
   int   ftvers;            /* output */
   long  optfunct;          /* output */
   int   maxlfnsize;        /* output */
   int   maxrfnsize;        /* output */
   int   maxsyssize;        /* output */
   int   maxadmissize;      /* output */
   int   maxaccsize;        /* output */
   int   maxpwdsize;        /* output */
   int   maxfpwdsize;       /* output */
   int   maxrecord;         /* output */
   int   maxacntsize;       /* output */
   int   maxlegalqsize;     /* output */
   int   maxcpwdsize;       /* output */
   int   maxlprocsize;      /* output */
   int   maxrprocsize;      /* output */
   int   maxcmdlen;         /* output */
};

The fields of the structure ft_prop have the following meanings:

ftpropvers

Version of the data structure.
ftpropvers must be supplied the value FT_PROPV1 or FT_PROPV2.

ftvers

Version of openFT, e.g. 1000 for Version 10.0 or 1210 for Version 12.1.

optfunct

(reserved for later use)

maxlfnsize

Maximum length for the local file name.

maxrfnsize

Maximum length for the file name in the remote system.

maxsyssize

Maximum length for the name of the remote system.

maxadmissize

Maximum length for the login name or transfer admission in the remote
system.

maxaccsize

Maximum length for the account number in the remote system.

maxpwdsize

Maximum length for the password in the remote system.

maxfpwdsize

Maximum length for the file password in the remote system.

maxrecord

Maximum record length.

maxacntsize

Maximum length for the account at the FTAM partner.

maxlegalqsize

Maximum length for the copyright.

maxcpwdsize

Maximum length for the password for creating a file in the remote system.

maxlprocsize

Maximum overall length for local follow-up processing.

maxrprocsize

Maximum overall length for remote follow-up processing.

maxcmdlen

Maximum length of the command that is to be executed in the remote system with ft_xcopen().
The maxcmdlen parameter is only available if ftpropvers is set to the value FT_PROPV2.

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.

Return value

0

No error.

-1

Error. The error type is stored in errorinfo.