|
M&M FDT 1.2.1 Online Specification |
Interfaces and Methods - Schemas - FDT Specification - Quicklinks - Abbreviations
4.3.12.2 IDtmOnlineParameter::DownloadRequest()
| This method can be called in the states: |    |
|
HRESULT DownloadRequest ( [in] FdtUUIDString invokeId, [in] FdtXPath parameterPath, [out, retval] VARIANT_BOOL* result ); |
Description:
| Sends the request to write online data to the device. |
Parameters:
| invokeId | Identifier of the request |
| parameterPath | FdtXPath within the XML document |
Return Value:
| result | TRUE Request accepted FALSE Request cannot be performed |
Behavior:
| Asynchronous function call that sends an XML document with the device specific parameters according to the specified schema of IDtmParameter::GetParameters() to the connected device. The response whether the download was successful will be provided by IDtmEvents::OnDownloadFinished(). In case of errors the DTM should inform the Frame Application via the callback interface IDtmEvents::OnErrorMessage(). Downloading of all parameters of the device, will be done if the path contains the root tag. In this case the DTM sends all parameters for the commissioning of the device. |
Comments:
| -/- |
Related dtmINSPECTOR hints:
| Thomas Weller created on 2006-10-23, last updated on 2006-10-23 |
| dtmINSPECTOR 1.2 makes OnErrorMessage() mandatory (test case DownloadRequest_F). |
| Thomas Weller created on 2009-07-27, last updated on 2009-07-27 |
| If a device has no parameters for writing (only for reading), is it ok that the DTM returns FALSE for DownloadRequest()? dtmINSPECTOR tests will fail if FALSE is returned. Returning TRUE and finishing the download successfully seems to be the better choice. Please consider that returning FALSE in a real FDT container may result in an error message which causes the administrator analyze the problem - although there is no problem. |
© 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.