|
M&M FDT 1.2.1 Online Specification |
Interfaces and Methods - Schemas - FDT Specification - Quicklinks - Abbreviations
4.3.12.3 IDtmOnlineParameter::UploadRequest()
| This method can be called in the states: |    |
|
HRESULT UploadRequest ( [in] FdtUUIDString invokeId, [in] FdtXPath parameterPath, [out, retval] VARIANT_BOOL* result ); |
Description:
| Sends the request to read online data from a 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 requires a DTM to upload parameters according to the path which points to an element of the XML document of IDtmParameter::GetParameters() from the connected device. The response whether the upload was successful will be provided by IDtmEvents::OnUploadFinished(). In case of errors the DTM should inform the Frame Application via the callback interface IDtmEvents::OnErrorMessage(). Uploading of all parameters of the device, will be done if the path contains the root tag. In this case the DTM loads all parameters from the device which were send during commissioning. |
Comments:
| -/- |
Related dtmINSPECTOR hints:
| Thomas Weller created on 2006-10-23, last updated on 2006-10-23 |
| According to Test Case TcExUploadRequest_F the DTM can only return FALSE if it is in the wrong state (not 'communication set' or higher). In all other cases it must return true (which means in general accept the upload), try to upload and provide a error description in OnUploadFinished() if communication is not possible. |
| Thomas Weller created on 2009-07-27, last updated on 2009-07-27 |
| If a device has no parameters for reading (only for writing), is it ok that the DTM returns FALSE for UploadRequest()? dtmINSPECTOR tests will fail if FALSE is returned. Returning TRUE and finishing the upload 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.