|
M&M FDT 1.2.1 Online Specification |
Interfaces and Methods - Schemas - FDT Specification - Quicklinks - Abbreviations
4.3.2.1 IDtm2::Environment2()
| This method can be called in the states: |   |
|
HRESULT Environment2 ( [in] BSTR systemTag, [in] IFdtContainer* container, [in] FdtXmlDocument frameInfo, [out, retval] VARIANT_BOOL* result ); |
Description:
| Is called by a Frame Application supporting 1.2.1 or higher to set the systemTag, the back pointer to the Frame Application and an XML document providing frame version information. Such a Frame Application will not call the IDtm::Environment() method. |
Parameters:
| systemTag | Identifier for the device instance; set by the Frame Application |
| container | Back pointer to the Frame Application |
| frameInfo | XML document containing frame version information by the DTMEnvironmentSchema |
Return Value:
| result | TRUE DTM has accepted the data FALSE The operation failed. |
Behavior:
| Is called by the Frame Application supporting 1.2.1 or higher to initialize a DTM supporting 1.2.1 or higher for a device instance. Furthermore the Frame Application passes the pointer to its own main interface and a document providing Frame Application version information. A DTM needs the systemTag during runtime for navigation or to identify itself at the event interface of the Frame Application. The DTM should not store the systemTag to prevent side effect if a Frame Application copies, moves, or deletes data sets. |
Comments:
| The systemTag is independent of communication tags (e.g. HART device tag). |
© 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.