|
M&M FDT 1.2.1 Online Specification |
Interfaces and Methods - Schemas - FDT Specification - Quicklinks - Abbreviations
4.3.6.1 IDtmDocumentation::GetDocumentation()
| This method can be called in the states: |      |
|
HRESULT GetDocumentation ( [in] FdtXmlDocument functionCall, [out, retval] FdtXmlDocument* result ); |
Description:
| Returns the device specific documentation according to the function call as XML document. |
Parameters:
| functionCall | XML document containing the function id for the requested document specified by the DTMFunctionCallSchema |
Return Value:
| result | XML document containing the requested documentation specified by the DTMDocumentationSchema |
Behavior:
| This method returns an XML-Document which can be used directly for documentation purposes. The format of this document is defined by the passed function call id, which is available via IDtm::GetFunctions() Only functions with the attribute ‘printable’ = TRUE will be supported. The Frame Application can use a XSL style sheet to transform the returned XML document to HTML. Nesting DTM specific style sheets can be used to transform the XML document into a DTM specifc HTML.Within these nested style sheets also hyperlinks to additional documents or into the World Wide Web can be placed. |
Comments:
| For an example style sheet please have a look to DTMDocumentationStyle.xsl. Refer to chapter 13.1 |
© 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.