Standard Types

Type definitions are available for many parameters to the AFTP API calls. For example, the AFTP type AFTP_LENGTH_TYPE is an alias for the C type unsigned long.

Use the AFTP types instead of the corresponding C types. Doing so protects you from changes to the parameters in future releases. If you use the AFTP types, you only need to recompile your code to use new API definitions. If you use the C types, you need to modify your program source code to reflect changes to new C types.

The AFTP API avoids complex structures and pointers to structures for type definitions. These complex structures might not be supported in all languages. The only exception is the string construct that is found in many languages.

The AFTP standard types are shown in the following table.

TypeDescription
AFTP_HANDLE_TYPEAFTP connection object identifier
AFTP_ALLOCATION_SIZE_TYPEFile allocation size
AFTP_BLOCK_SIZE_TYPEFile block size
AFTP_BOOLEAN_TYPEBoolean type (FALSE=0, TRUE=1)
AFTP_DATA_TYPE_TYPEFile data types that can be transferred
AFTP_DATE_MODE_TYPEDate mode used for transferred files
AFTP_DETAIL_LEVEL_TYPE Amount of information to be output when AFTP generates error messages
AFTP_FILE_TYPE_TYPEKind of file (directory or file) listed by AFTP
AFTP_INFO_LEVEL_TYPEAmount of information listed for a file by AFTP
AFTP_LENGTH_TYPESize of input buffers, and actual returned length of buffers in AFTP
AFTP_RETURN_CODE_TYPEReturn codes output by AFTP
AFTP_RECORD_FORMAT_TYPEFile record formats
AFTP_RECORD_LENGTH_TYPEFile record length
AFTP_SECURITY_TYPEAPPC security types
AFTP_TRACE_LEVEL_TYPELevels of tracing information output by AFTP
AFTP_VERSION_TYPEAFTP program version numbers
AFTP_WRITE_MODE_TYPEDifferent ways that AFTP can write to a file
Show: