M&M FDT 1.2.1 Online Specification
 IDtmParameter::GetParameters() method information


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

4.3.13.1 IDtmParameter::GetParameters()


This method can be called in the states:            

HRESULT GetParameters (
[in] FdtXPath parameterPath,
[out, retval] FdtXmlDocument* result
);


Description:
Returns an XML document with the device specific parameters.

Parameters:
parameterPathFdtXPath within the XML document


Return Value:
resultXML document with the device specific parameters specified by the DTMParameterSchema


Behavior:
Returns an XML document with the device specific parameters. The document can be empty for devices without public data. The method provides the transient data of a DTM. That means, if the DTM is active or has for example an open user interface the provided parameter can differ from the actual stored instance data. The state of the received data is classified within the DTMParameterSchema. The DTM must always return within the XML document the current DtmDeviceType. That means in case of an update of the DTM the changed DtmDeviceType must be returned instead of the DtmDeviceType given during IDtm::InitNew().

Comments:
The integration of devices depends on the amount of data which is avaliable via this method. Thus a DTM should provide all data which are necessary to support a seamless integration. See also chapter: State machine of instance data


Related dtmINSPECTOR hints:
Thomas Weller
created on 2006-08-03, last updated on 2006-08-03
After an Upload (IDtmOnlineParameter::UploadRequest()) has been performed, the attribute dataSetState must be set to "allDataLoaded". This is tested by the test TcExInstanceData since dtmINSPECTOR 1.2. Consider a regularly executed batch job if (dataSetState != "allDataLoaded") { // the dataset has been modified DownloadRequest(...); // write to the device UploadRequest(...); // remove modified flag } or something like this. In case the dataSetState is not set to "allDataLoaded" after an upload, this will result in some kind of endless loop.
Thomas Weller
created on 2006-08-03, last updated on 2006-08-03
The element <CommunicationTypeEntry> is mandatory. In DTMInformationSchema is is marked as optional to be backward compatibel. The element was introduced with FDT 1.2 Addendum. Presence of this element is first tested with the official release of dtmINSPECTOR 1.2 The new test case is TcExGetInformation_E.
Other methods which also need to be updated: IDtmInformation::GetInformation() and IFdtCommunication::GetSupportedProtocols()


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