HP Integrity NonStop H-Series - Manual (Page 106)

in
remote file name.
out
a string containing the local file name and a list of attributes for the local file. You must specify
the attributes in the order indicated below; use commas as placeholders and omit spaces.
The syntax for transferring ASCII or binary files is:
[[ filecode],[ primary],[ secondary],[ maxextents]]
Thesyntax for transferring structured files is:
[[ filetype],[ filecode],[ primary],[ secondary],
API Routines 115
[ maxextents],[ record-len],[ pri-key-len],
[ key-offset],[ index-blk-len ]]
If "out" is left unspecified, by setting out as"", the local file name will be the same as the remote
file name (that is, in) and the file attributes take the default values.
filetype
indicates the type of file for structured file transfer:
e: indicates an entry-sequenced file.
k: indicates a key-sequenced file.
r: indicates the relative file.
filecode
indicates the file code of the local file. File code is a number between 0 and 32767. When
FTP is in primary transfer mode (set by calling FTPsettype () and specifying type I), the
default code is zero (0). When FTP is in ASCII mode (set by calling FTPsettype () and
specifying type A), the default code is 101. The file code attribute overrides the current
setting of FTPsetfilecode ().
primary
indicates the primary extent size in pages (2048-byte units) of the local file. primary is an
integer from 1 through 65535. The default is determined internally.
secondary
indicates the secondary extent size in pages (2048-byte units) of the local file. secondary
is an integer from 1 through 65535. For structured files, the default size is 16 pages. For
unstructured files, the default is determined internally.
maxextents
indicates the maximum number of extents of the local file. maxextents is an integer from 1
through 978. The default value is 978 extents.
record-len
indicates the length of the records in a structured file.
pri-key-len
indicates the primary key length in a structured file.
key-offset
indicates the key offset in a structured file.
index-blk-len
indicates the index block length in a structured file.
tag
parameter to be used for the GUARDIAN nowait operation initiated by FTPget_nw.
The return value is -1 if the routine fails, otherwise the routine is successful. The error number is set
accordingly.
106 FTP API External Specification