M&M FDT 1.2.1 Online Specification
 IDtmParameter::SetParameters() method information


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

4.3.13.2 IDtmParameter::SetParameters()


This method can be called in the states:            

HRESULT SetParameters (
[in] FdtXPath parameterPath,
[in] FdtXmlDocument xmlDocument,
[out, retval] VARIANT_BOOL* result
);


Description:
Sets changes of device specific parameters.

Parameters:
parameterPathFdtXPath within the XML document
xmlDocumentXML document specified by the DTMParameterSchema


Return Value:
resultTRUE The DTM has accepted the complete document. FALSE The document contains invalid data and was not accepted.


Behavior:
Only values of the writable elements can be changed by calling SetParameters. The DTM must verify complete document according to the business rules before accepting the requested changes. The method returns TRUE if the DTM has accepted the changes for the complete document. The method returns FALSE if the DTM has rejected any of the value changes. The Transient data will remain unchanged.The DTM informs the Frame Application about the error via the callback interface IDtmEvents::OnErrorMessage(). The method works on the transient data of a DTM. That means that the new data are not stored implicitly. The DTM can request transient data to become persistent by calling IFdtContainer::SaveRequest().

Comments:
See also chapter: State machine of instance data




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