OSI/FTAM Programming Reference Manual

FTM Procedures
HP NonStop OSI/FTAM Programming Reference Manual—528611-001
4-122
FTM_READ_REQ_
FTM_READ_REQ_
This procedure allows you to request the transfer of some or all the contents of the
previously opened file. This procedure initiates the data-transfer regime. For a
description of the data-transfer regime, see the OSI/FTAM Programming Guide.
status return value
INT
indicates the outcome of the call. For a list of possible ZAPS-VAL-STATUS-xxx
values, see Table B-1 on page B-2.
cepi input
INT:value
is the connection endpoint identifier (CEPI) used to identify the specific
association. Use the CEPI value returned from the FTM_INITIALIZE_REQ_
procedure for this association. For additional information on using the cepi
parameter, see the OSI/FTAM Programming Guide.
cepi is a required parameter.
fadu-id input
INT .EXT:ref:(ZFTM-DDL-FADU-ID)
specifies the target FADU. Valid values are the following:
ZFTM-VAL-FADUID-FIRST for the ZFIRSTLAST field. This value specifies the
beginning of the first FADU after the root FADU and applies only to FTAM-1,
FTAM-3, and NBS-9 document types.
For FTAM-2 document types, several options are possible.
To read the entire file, use the ZBEGINEND field, where the value of ZFTM-
VAL-FADUID-BEGIN is valid.
To read individual nodes of an FTAM-2 file, use a fadu-id value of first, last,
current, next, previous, or node number, where the following values are
possible:
status := FTM_READ_REQ_ ( cepi ! I
, fadu-id ! I
, access-context ! I
, [ tag ] ) ; ! I
Data Structure Field Possible Values
ZFIRSTLAST ZFTM-VAL-FADUID-FIRST
ZFTM-VAL-FADUID-LAST
ZRELATIVE ZFTM-VAL-FADUID-PREVIOUS