|
M&M FDT 1.2.1 Online Specification |
Interfaces and Methods - Schemas - FDT Specification - Quicklinks - Abbreviations
4.3.2.2 IDtm2::SetSystemGuiLabel()
| This method can be called in the states: |        |
|
HRESULT SetSystemGuiLabel ( [in] FdtXmlDocument systemGuiLabel, [out, retval] VARIANT_BOOL* result ); |
Description:
| This method is called by the Frame Application to set a unique human readable identifier of the DTM instance in the context of the Frame Application. |
Parameters:
| systemGuiLabel | XML document containing a unique human readable identifier of the DTM instance in the context of the Frame Application. Document specified by DTMSystemGuiLabelSchema |
Return Value:
| result | True DTM has accepted the data False The operation failed. |
Behavior:
| This method is called by the Frame Application in order to set a system label e.g. for a message box or a user interface which is part of the DTM and can not be embedded within a Frame Application. The Frame Application sets a unique human readable identifier of the DTM instance in the context of the Frame Application which guarantees a unique identification between the device and e.g. a message box of a DTM. The DTM must use this system label for all kinds of windows that will be opened by the DTM themselves. May be the DTM can extend this title with specific information. The Frame Application has to call this method as early as possible. As long as the method is not called the DTM has to use the tag of the device as human readable string by default. |
Comments:
| The human readable identifier must not be stored by the DTM. It is recommended to update the labels of all open windows when SetSystemGuiLabel() is called. |
Related dtmINSPECTOR hints:
| Thomas Weller created on 2006-12-05, last updated on 2006-12-05 |
| Quote: "As long as the method is not called the DTM has to use the tag of the device as human readable string by default." dtmINSPECTOR will check if it uses the systemTag (which is not the tag of the device!). |
© 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.