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


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

4.5.6.2 IFdtChannelScan::CancelAction()


This method can be called in the states:        

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


Description:
Cancels an active asynchronous scan request identified by its invoke ID.

Parameters:
invokeIdUnique identification of scan request.


Return Value:
resultTRUE Cancel of scan request accepted. FALSE Cancel of scan request not accepted.


Behavior:
The Frame Application calls this method to cancel active scan request operation. If the channel has accepted the cancel action request it will return TRUE. The channel may not be able to cancel the action immediately after accepting the request, but it should do it as soon as possible. In this case the channel will not fire the IDtmScanEvents::OnScanResponse() event. If the channel can’t cancel the operation FALSE is returned. IDtmScanEvents::OnScanResponse() event is fired when the operation has finished.

Comments:
CancelAction() does not automatically invalidate the provisional scan results, but stops retrieving additional information. The communication channel should stop the scan process.




© 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.