IDtm::PrepareToReleaseCommunication() method information

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

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

4.3.1.8 IDtm::PrepareToReleaseCommunication()

This method can be called in the states:

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

Description:

Used to inform the DTM that it has to release it links to the communication components.

Parameters:

Return Value:

result

TRUE The DTM will release its references at the communication pointer FALSE The operation failed.

Behavior:

The DTM has to release all references to the communication pointer set during SetCommunication(). The method returns FALSE if a communication call is active and cannot be terminated. The DTM sends a notification via IDtmEvents::OnPreparedToReleaseCommunication() to the Frame Application if the communication pointer can be released.

Comments:

The method returns FALSE if communication call is active and cannot be terminated. The method returns TRUE if DTM accepts shutdown of communication. DTM has to fire progress events to inform Frame Application about ongoing progress if IDtmEvents::OnPreparedToReleaseCommunication() notification may take a longer time, for example if still some communication calls have not returned. See also 4.9.1.13, OnProgress() and 4.3.1.11 SetCommunication()

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