M&M FDT 1.2.1 Online Specification
 IDtmSingleDeviceDataAccessEvents::OnItemListResponse() method information


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

4.9.12.1 IDtmSingleDeviceDataAccessEvents::OnItemListResponse()


This method can be called in the states:            

HRESULT OnItemListResponse (
[in] FdtUUIDString invokeId,
[in] FdtXmlDocument response
);


Description:
Provides the response to ItemListRequest() identified by the invoke id. ItemListResponse provides an XML document containing a list of the available device specific parameters and process values. Within a DTM this list may contain items related to configuration parameters, process values as well as asset management related data like stroke counter. In DTM state ‘configured’ the returned item list is based on the current instance data set, which could be different from the configuration of the device. In this case Read- and WriteRequests may fail.

Parameters:
invokeIdUnique identifier for the request
responseXML document containing a DtmItemInfoList with the actual available parameters specified by the DTMItemListSchema


Return Value:


Behavior:
The method provides a list of items that can be read or written from/to the DTM via ReadRequest() or written to the DTM via WriteRequest(). The source for this data is the device itself. 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 related items can be identified via the attribute ‘semanticId’ (refer to chapter FDT Data Types)

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 IDtmSingleDeviceDataAccess::OnDeviceItemListChanged()




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