IDtm::Environment() method information

M&M FDT 1.2.1 Online Specification
IDtm::Environment() method information

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

4.3.1.2 IDtm::Environment()

This method can be called in the states:

HRESULT Environment (
[in] BSTR systemTag,
[in] IFdtContainer* container,
[out, retval] VARIANT_BOOL* result
);

Description:

Is called by the Frame Application to set the systemTag and the back pointer to the Frame Application.

Parameters:

systemTag	Identifier for the device instance; set by the Frame Application
container	Back pointer to the Frame Application

Return Value:

result

TRUE DTM has accepted the data FALSE The operation failed.

Behavior:

Is called by the Frame Application to initialize a DTM for a device instance. Furthermore the Frame Application passes the pointer to its own main interface. 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.