OSI/FTAM Programming Reference Manual

FTM Procedures
HP NonStop OSI/FTAM Programming Reference Manual—528611-001
4-53
FTM_DATA_IND_
FTM_DATA_IND_
This procedure allows you to receive, or read, a block of data from the previously
opened file involved in a data transfer.
error return value
INT
indicates the outcome of the call. For a list of defined values, see Appendix B,
NonStop FTAM Initiator Error Messages.
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.
buffer-size input
INT(32) :value
specifies the size, in octets, of the buffer used for retrieving data-value. This is
the maximum number of octets that FTM_DATA_IND_ returns to the caller. If you
specify a value of 0 for this parameter and also for the start-position
parameter, the more-data parameter returns the number of octets to be read, and
the FTAM API copies no data into the data-value buffer.
buffer-size is a required parameter.
data-value output
STRING .EXT:ref:*
contains the data returned from the remote responder. This parameter consists of a
data header followed by a series of one or more data elements.
The maximum allowable size of the data-value parameter of an
FTM_DATA_IND_ call is 25 KB. For details on calculating the size of data-value,
see the OSI/FTAM Programming Guide.
error := FTM_DATA_IND_ ( cepi ! I
, buffer-size ! I
, data-value ! O
, [ more-data ] ! O
, [ next-position ] ! O
, [ start-position ] ) ; ! I