IDtm::PrepareToDelete() method information

M&M FDT 1.2.1 Online Specification
IDtm::PrepareToDelete() method information

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

This method can be called in the states:

HRESULT PrepareToDelete (
[out, retval] VARIANT_BOOL* result
);

Description:

Returns TRUE if the device instance data set can be deleted at the Frame Applications database. Used to inform the DTM that it has to clean up e.g. its log files or protocols. The data set will be deleted by the Frame Application.

Parameters:

Return Value:

result

TRUE Data set can be deleted FALSE The operation failed.

Behavior:

The method is used to inform a DTM that it has to clean up e.g. its log files or protocols. After this function call the data set will be deleted by the Frame Application. The Frame Application is responsible to ensure the pre-conditions for the delete. That means that the Frame Application must ensure, that all DTM instance related to this data set are shut down (either Zombie-State or released).If the DTM returns FALSE the Frame Application can inform the user to close the user interfaces or can terminate them by ExitApplication() or IDtmActiveXControl::PrepareToRelease(). In general a DTM will finish its current communication process during the release of its user interfaces.

Comments:

-/-

Comments from fdtFAQ Forum:

Thomas Weller
created on 2006-12-05, last updated on 2006-12-05

Quote: "DTM will finish its current communication process". The DTM has already released its communication pointers when returning from "communication set" to state "configured", so communication is not an issue here.

Thomas Weller
created on 2006-08-10, last updated on 2006-08-10

The DTM must clean the paths GetInstanceRelatedPath() and GetProjectRelatedPath() when being deleted from the project.

Thomas Weller
created on 2009-08-04, last updated on 2009-08-04

Quote: "... the Frame Application must ensure ... (either Zombie-State or released)." If the DTM is in "zombie" state, PrepareToDelete() must not be called according chapter 4.2.2 - DTM State Machine. A state called "released" does not exist in chapter 4.2.2 - DTM State Machine.

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