M&M FDT 1.2.1 Online Specification
 IDtmSingleInstanceDataAccess::GetItemList() method information


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

4.3.19.1 IDtmSingleInstanceDataAccess::GetItemList()


This method can be called in the states:            

HRESULT GetItemList (
[out, retval] FdtXmlDocument* result
);


Description:
GetItemList() returns an XML document containing a list of the available device specific parameters. Within a DTM this list may contain items related to configuration parameters as well as asset management related data.

Parameters:


Return Value:
resultXML document containing a DtmItemInfoList with the actual available parameters specified by the DTMItemListSchema


Behavior:
This method provides a list of items that can be accessed via the DTM. The source for this data is the DTM instance data set. Items provided within these list may also be available as channel objects (provided by IDtmChannel::GetChannels()) or modeled as an exported variable (DtmVariable provided by IDtmParameter::GetParameters() or IBtmParameter::GetParameters()). The relation of these items can be identified via the attribute ‘semanticId’

Comments:
The contents of the provided XML document may depend on the current configuration of the device. If the contents is changed, a DTM has to inform the Frame Application by sending IDtmSingleInstanceDataAccess::OnInstanceItemListChanged(). Dependent on the user roles, the item list items may vary.




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