IDtm::InvokeFunctionRequest() method information

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

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

4.3.1.5 IDtm::InvokeFunctionRequest()

This method can be called in the states:

HRESULT InvokeFunctionRequest (
[in] FdtUUIDString invokeId,
[in] FdtXmlDocument functionCall,
[out, retval] VARIANT_BOOL* result
);

Description:

Starts a function of a DTM.

Parameters:

invokeId	Identifier for the started function.
functionCall	XML document containing the DTM specific function id for the requested function or user interface specified by the DTMFunctionCallSchema

Return Value:

result

TRUE The function started. FALSE The function call failed.

Behavior:

The function call id associates a DTM with a functional/logical context. Each DTM can provide more than one function. The functions supported by a DTM can be requested via GetFunctions() Functions with user interface are started via IDtmApplication::StartApplication(), IDtmActiveXInformation::GetActiveXGuid() or IDtmActiveXInformation::GetActiveXProgId() and can work asynchronous. If the called function is finished or terminated by the user the DTM send an OnApplicationClosed() event to the Frame Application. Function calls without user interface are asynchronous as well. For this functions the DTM sends an IDtmEvents::OnInvokedFunctionFinished() event if the function is finished.

Comments:

To prevent side effects the Frame Application should not send further request to the DTM proceeding the function call.

Related dtmINSPECTOR hints:

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

According to dtmINSPECTOR Test

TcExInvokeFunction_A the DTM should return FALSE in case a function with hasGUI="1" is used.
TcExInvokeFunction_B the DTM should return FALSE in case a function with invalid XML is used.
TcExInvokeFunction_D the DTM should return FALSE if the function is called in a wrong state.

Comments from fdtFAQ Forum:

Thomas Weller
created on 2013-09-25, last updated on 2013-09-25

InvokeFunctionRequest() is designed to work with functions which have no user interface. Please note that InvokeFunctionRequest() is called at the DTM business logic. The DTM may run separately from the user interface (yes, even in FDT 1.2) and any dialogs shown by the DTM may not open on the expected screen, even on a different PC, which makes them inaccessible for the user.

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