OSI/FTAM Programming Guide

Using FTM Procedure Calls
HP NonStop OSI/FTAM Programming Guide—528612-001
4-47
Setting Procedure Parameters
11. Call FTM_TRANSFER_END_CNF_ to retrieve the data sent by the confirm. Check
action-result.
If the action-result value is ZFTM-VAL-ACTION-SUCCESS, the responder
successfully read the file.
Setting Procedure Parameters
To provide your application with details about the file from which you wish to read, use
these parameters of the FTM_READ_REQ_ procedure:
1. The fadu-id (ZFTM-DDL-FADU-ID) parameter allows you to identify the FADU to
read from the file. You can use either of these methods to identify FADUs:
a. For FTAM-1, FTAM-3, and NBS-9 document types, use the ZFIRSTLAST field
of the ZFTM-DDL-FADU-ID data structure. The only value allowed is
ZFTM-VAL-FADUID-FIRST, which identifies the beginning of the first FADU
after the root FADU.
b. For FTAM-2 document types, several options are possible.
To read the entire file, use the ZBEGINEND field, where only the value of
ZFTM-VAL-FADUID-BEGIN is allowed.
To read individual nodes of an FTAM-2 file, use a fadu-id value of first, last,
current, next, previous, or node number, where these values are possible.
For an explanation of FADUs, see Section 2, ISO FTAM Concepts.
2. The access-context (ZFTM-DDL-ACCESS-CNTXT) parameter specifies the
file-access structure for transfers in the data-transfer regime. Valid values include:
a. ZFTM-VAL-ACCESSCNTXT-FA (flat all data units). Node descriptors use this
value to transfer data. This value applies to FTAM-2 files only (when you wish
to transfer node descriptors as well as data).
b. ZFTM-VAL-ACCESSCNTXT-UA (unstructured all data units). Use this value to
transfer data only. This value applies to FTAM-1, FTAM-2, and FTAM-3 files.
Data Structure Field Possible Values
ZFIRSTLAST ZFTM-VAL-FADUID-FIRST
ZFTM-VAL-FADUID-LAST
ZRELATIVE ZFTM-VAL-FADUID-PREVIOUS
ZFTM-VAL-FADUID-CURRENT
ZFTM-VAL-FADUID-NEXT
ZFADUNUMBER (specifies number of FADUs separating desired FADU from
root FADU)