M&M FDT 1.2.1 Online Specification
 IFdtChannel::SetChannelParameters() method information


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

4.5.1.3 IFdtChannel::SetChannelParameters()


This method can be called in the states:              

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


Description:
Sets changes of channel specific parameters.

Parameters:
parameterPathFdtXPath within the XML document
protocolIdUUID of a fieldbusprotocol. This UUID must be one of the UUIDs returned by GetSupportedProtocols() and specified by DTMProtocolsSchema
xmlDocumentXML document specified by a schema e.g. like FDTHARTChannelParameterSchema or FDTProfibusChannelParameterSchema


Return Value:
resultTRUE The channel has accepted the complete document with all changes FALSE The document contains invalid changes


Behavior:
The method passes an XML document with the channel specific parameters according to a fieldbus specific schema. The fieldbus is defined by the parameter protocolId. Returns TRUE if the channel has accepted the complete document with all changes. FALSE means that the channel has rejected all transferred changes. In this case the channel informs the Frame Application about the error in detail 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. Transient data will become persistent e.g. 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.