M&M FDT 1.2.1 Online Specification
 IDtmOnlineParameter::CancelAction() method information


Interfaces and Methods   -   Schemas   -   FDT Specification   -   Quicklinks   -   Abbreviations

4.3.12.1 IDtmOnlineParameter::CancelAction()


This method can be called in the states:        

HRESULT CancelAction (
[in] FdtUUIDString invokeId,
[out, retval] VARIANT_BOOL* result
);


Description:
Cancels an active parameter-upload or download.

Parameters:
invokeIdIdentifier of the action to be canceled


Return Value:
resultTRUE Cancel action accepted FALSE Cancel action cannot be performed


Behavior:
The method cancels an active parameter-upload or download. If the DTM has accepted the CancelAction request it returns TRUE. The DTM may not be able to cancel the action immediately after accepting the request, but it should do so as soon as possible. The DTM must not fire the IDtmEvents::OnDownloadFinished() or IDtmEvents::OnUploadFinished() events. If the DTM cannot cancel the selected action, it must return FALSE and must fire one of the "finished" events when the action is finished.

Comments:
-/-




© by M&M Software GmbH, parts of this website taken from FDT Interface Specification Version 1.2.1, © by FDT Group, AISBL.
This website is published for support of M&M products as granted in license conditions, chapter 2.1.
Last updated 2015-02-05 15:17
Email: FDT Technical Support Line.