acmsdi_cancel
2.7 acmsdi_cancel
TP Desktop Connector client programs call this service in a nonblocking or
forced nonblocking environment to cancel a currently active ACMS task. Use
the acmsdi_cancel service only if you invoke a task using nonblocking services.
Do not use the acmsdi_cancel service from a presentation procedure or from an
asynchronous completion routine.
Format
acmsdi_cancel (submitter id,
call_id,
[cancel_reason],
reserved,
[completion_status],
completion_routine,
1
[call_context])
Parameters
submitter_id
Type: ACMSDI_SUBMITTER_ID
Access: read
Mechanism: by reference
The submitter_id for the session associated with the task that is being canceled.
call_id
Type: ACMSDI_CALL_ID
Access: read
Mechanism: by reference
The call_id for the task that is being canceled, which was passed back on the
acmsdi_call_task service.
cancel_reason
Type: long int
Access: read
Mechanism: by value
Optional parameter containing the status value of the reason code for the
cancel request. This value is passed to the Application Execution Controller
(EXC) by the TP Desktop Connector gateway. The default is ACMSDI_CALL_
CANCELED, "the task was canceled by the task submitter".
1
For nonblocking only, see Section 2.3.
2–18 TP Desktop Connector Portable API Client Services
