OSI/FTAM Programming Reference Manual

FTM Procedures

HP NonStop OSI/FTAM Programming Reference Manual—528611-001

4-16

FTM_CANCEL_REQ_

This procedure allows you to request cancellation of the data-transfer regime. If

cancellation is successful, the results of any interrupted read or write operations are

unknown and the data-transfer regime ends. The association moves to the file-open

regime upon successful completion of the cancellation request. For a description of

these regimes, 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.

action-result input

INT(32):value

allows you to summarize the type of information contained in the diagnostic

parameter. The action-result value is never less severe than the most severe

diagnostic value. The following are the valid values:

ZFTM-VAL-ACTION-SUCCESS

ZFTM-VAL-ACTION-FAILURE

action-result is an optional parameter. If you do not supply this parameter, it

defaults to ZFTM-VAL-ACTION-SUCCESS, indicating that the diagnostic

parameter contains only informative diagnostic information.

diagnostic input

INT .EXT:ref:(ZFTM-DDL-DIAGNOSTIC)

allows you to provide user information that explains the reason for termination of

activities. For a complete list of possible diagnostic values, see Appendix C, ISO

status := FTM_CANCEL_REQ_ ( cepi ! I

, [ action-result ] ! I

, [ diagnostic ] ! I

, [ tag ] ); ! I