296. XML

XML routines

296.1. Summary of Module Globals

List of Global Functions

  • XMLError - The error string from the xml parser. It should be used when the agent did not return content. A reset happens before a new XML parsing starts.

  • XMLToYCPFile - Read XML file into YCP

  • XMLToYCPString - Read XML string into YCP

  • YCPToXMLFile - YCPToXMLFile() Write YCP data into formated XML file

  • xmlCreateDoc - define a new doc type with custom settings, if not defined, global settings will be used.

List of Global Variables

    296.2. Global Functions

    296.2.1. XMLError

    The error string from the xml parser. It should be used when the agent did not return content. A reset happens before a new XML parsing starts.

    Return value

    • string - parser error

    296.2.2. XMLToYCPFile

    Read XML file into YCP

    Function parameters

    • string xmlFile

    Return value

    • map<string, any> - Map with YCP data

    296.2.3. XMLToYCPString

    Read XML string into YCP

    Function parameters

    • string xmlString

    Return value

    • map<string, any> - Map with YCP data

    296.2.4. YCPToXMLFile

    YCPToXMLFile() Write YCP data into formated XML file

    Function parameters

    • symbol docType

    • map contents

    • string outputPath

    Return value

    • boolean - true on sucess

    296.2.5. xmlCreateDoc

    define a new doc type with custom settings, if not defined, global settings will be used.

    Function parameters

    • symbol doc

    • map docSettings

    Return value

    • void

    296.3. Global Variables

    296.4. Module Requirements

    none