OSI/FTAM Programming Reference Manual

FTM Procedures
HP NonStop OSI/FTAM Programming Reference Manual—528611-001
4-54
FTM_DATA_IND_
For further details on the structure of data-value, see the OSI/FTAM
Programming Guide.
data-value is a required parameter.
more-data output
INT(32) .EXT:ref:1
indicates that more data is available. The application should call FTM_DATA_IND_
again to obtain the remaining data. more-data specifies the size in bytes of the
remaining data including all necessary headers. A value of 0 indicates that no
more user data is remaining; a value other than 0 means that the buffer used for
retrieving the data-value parameter was too small to contain the entire data
indication.
more-data is an optional parameter.
next-position output
INT(32) .EXT:ref:1
specifies the offset of the next octet to be returned from the FTAM internal data
area. The returned value is used as the start-position in a subsequent call to
FTM_DATA_IND_ to receive the next portion of user data starting after the last
returned byte.
next-position is an optional parameter.
start-position input
INT(32):value
specifies the first data element to be returned by FTM_DATA_IND_. If you omit this
parameter, the value defaults to 0.
If you need to make multiple calls to the FTM_DATA_IND_ procedure to retrieve all
the data contained in the data indication, for the first FTM_DATA_IND_ call, the
start-position parameter must be set to 0. In subsequent calls, the parameter
must be set to the next-position value.
If only a single call to the FTM_DATA_IND_ procedure is needed to retrieve the
data contained in the indication, you do not need to set the start-position
parameter. In this case, the default of 0 is the correct value.
start-position is an optional parameter.