M&M FDT 1.2.1 Online Specification
 IDtmSingleDeviceDataAccess::WriteRequest() method information


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

4.3.18.4 IDtmSingleDeviceDataAccess::WriteRequest()


This method can be called in the states:        

HRESULT WriteRequest (
[in] FdtUUIDString invokeId,
[in] FdtXmlDocument itemList
);


Description:
WriteDeviceRequest performs asynchronous exchange of a data structure with a DTM.

Parameters:
invokeIdUnique identifier for the request
itemListList of required items described by a DtmItemList specified by the DTMItemListSchema


Return Value:


Behavior:
Via this method the Frame Application requests a DTM to write the specified data to its device according to the device specific rules. Error information will be handed over to the Frame Application via the related response XML-Document. If a request can not be accepted by the DTM it is possible to send the response within the call. Execution of the WriteRequest() method must not change the data of the instance data set. The DTM has to check, whether it could manipulate the flag ‘modifiedInDevice’ (refer chapter ‘FDT Data Types) in the instance data set by requesting a lock. If the lock request fails the DTM has also to refuse the WriteRequest() - an appropriate response must be provided. The DTM must always accept the request. If the request cannot be processed, the reason for failure must be provided asynchronously as part of the response. The response (either failure or the result) must be provided at IDtmSingleDeviceDataAccessEvents::OnWriteResponse().

Comments:
In order to inform the Frame Application regarding an ongoing activities It is recommended to fire the IDtmEvents::OnProgress() event while a response is pending. The DTM should be able to handle more than one request at a time. The order of execution is like the order of appearance of the requests. For each request there should be a corresponding response.




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