OSI/FTAM Programming Reference Manual

FTM Procedures
HP NonStop OSI/FTAM Programming Reference Manual528611-001
4-21
FTM_CANCEL_IND_
FTM_CANCEL_IND_
This procedure allows you to retrieve indication information on a responder request
to cancel the data-transfer regime. The association is returned to the file-open
regime. For a description of these regimes, see the OSI/FTAM Programming Guide.
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.
action-result output
INT(32) .EXT:ref:1
summarizes information available in the diagnostic parameter. The
action-result value is never less severe than the most severe diagnostic
value. Valid values are the following:
ZFTM-VAL-ACTION-SUCCESS
ZFTM-VAL-ACTION-FAILURE
Even for a successful operation, the diagnostic parameter might include one or
more informative messages. A value of ZFTM-VAL-ACTION-FAILURE indicates
that the operation was not successful, and diagnostic is likely to contain one or
more permanent diagnostic messages.
action-result is an optional parameter.
diagnostic output
INT .EXT:ref:(ZFTM-DDL-DIAGNOSTIC)
provides information that qualifies the success or explains the failure of a
requested action. For a complete list of possible diagnostic values, see
Appendix C, ISO FTAM Diagnostic Messages.
error := FTM_CANCEL_IND_ ( cepi ! I
, [ action-result ] ! O
, [ diagnostic ] ) ; ! O