Version Information
Release Notes, Update information, Certifications and Frequently Asked Questions.
Concepts
Your first step into modern and powerful process visualization.
Deployment
Topics you need to know before using WinCC OA.
Security
Go beyond the norm in cybersecurity.
Engineering
Powerful tools for easy or complex engineering tasks.
Data Management
Classify, structure and archive your data.
Business Logic / Control
Endless possibilities in data processing for your projects.
- Introduction to CTRL
  An introduction to the product's own programming language Control(CTRL).
- Control Classes
  The overview of classes available in Control.
- Types of Control Functions
  An overview of the types of functions distinguished within Control.
- Control graphics
- CONTROL Functions
  - Functions A
  - Functions B
  - Functions C
  - Functions D
  - Functions E
  - Functions F
  - Functions G
  - Functions H
  - Functions I
  - Functions J
  - Functions K
  - Functions L
  - Functions M
  - Functions N
  - Functions O
  - Functions P
  - Functions Q
  - Functions R
  - Functions S
  - Functions T
  - Functions U
  - Functions V
  - Functions W
  - Functions X
    - xmlAppendChild()
      Adds a new child node into the DOM tree as child of given node. Optionally the node's value can be set.
    - xmlChildNodes()
      Writes all child nodes of the given node into the nodes' reference parameter.
    - xmlCloseDocument()
      Closes the created XML document and destroys the occupied memory. After this call, the document ID is no longer valid.
    - xmlDocumentFromFile()
      Opens a file and reads the complete content building the DOM structure in memory.
    - xmlDocumentFromString()
      Reads the complete content from a string and builds the DOM structure in memory.
    - xmlDocumentToFile()
      Stores the internal DOM tree in an arbitrary XML file.
    - xmlDocumentToString()
      Returns the internal DOM tree as a string result.
    - xmlElementAttributes()
      Returns all node attributes as a mapping.
    - xmlFirstChild()
      Returns an internal ID to the first child node in the DOM tree.
    - xmlGetElementAttribute()
      Reads the value of the given attribute into the value reference parameter of the node.
    - xmlIsSameNode()
      Checks whether two node IDs are pointing to the same internal node within the DOM tree.
    - xmlNamedChild()
      This function allows you to easily find a child node in an xml document.
    - xmlNewDocument()
      Starts the creation of a new document in memory and returns the document ID.
    - xmlNextSibling()
      Returns an internal ID for the next sibling of the given node.
    - xmlNodeName()
      Returns the name of a node.
    - xmlNodePosition()
      The function returns the position of a node inside of an XML document.
    - xmlNodeType()
      Returns the type of the given node.
    - xmlNodeValue()
      Returns the value of the given node.
    - xmlParentNode()
      Returns the internal ID for the parent node of the given node.
    - xmlRemoveElementAttribute()
      Removes the given attribute from its node.
    - xmlRemoveNode()
      Removes the given node from its parent node.
    - xmlrpcCall()
      Calls the function "function" on the server with the arguments of the parameter "args". If "result" is specified, the function waits for the answer from the server and saves the answer in "result". This corresponds to the call result = function(args[1], ...);
    - xmlrpcClient
      Starts an XmlRpc client. The XmlRpc client is a Ctrl module that handles the calls in the background.
    - xmlrpcCloseServer()
      Closes the connection to the server.
    - xmlrpcConnectToServer()
      Establishes a connection to an XmlRpc server on host "host" and port "port". If "secure" is TRUE, a https connection is built. Under Windows the OpenSSL installation is required. The connection is valid only as long as it is open. This means if the connection is broken, the requests for the server will fail. Using the parameter "id", the server can be identified in the following calls.
    - xmlrpcDecodeRequest()
      Decodes the request and extracts the function name and arguments of it.
    - xmlrpcDecodeValue()
      Re-converts an XmlRpc-coded string to a variable.
    - xmlrpcEncodeResponse()
      Encodes the result in an XmlRpc message.
    - xmlrpcEncodeValue()
      Converts a "value" variable to an XmlRpc-coded string.
    - xmlrpcHandler()
      CtrlXmlRpc is a CTRL extension including XML-RPC functions. XML-RPC is a protocol for web services, similar to SOAP but much simpler.
    - xmlrpcSetGzipLimit()
      Defines from which size the contents of a request are compressed (gzip).
    - xmlSetElementAttribute()
      Sets the attribute of a node to given value.
    - xmlSetNodeValue()
      Sets the node's value to the given value.
  - Functions Y
  - Functions Z
- CtrlExtension
  The CtrlExtension allows the addition of custom C++ code.
- CTRL Debugger
  You can use the CTRL debugger to debug the Control programming language. The debugger can be used via its own panel, which also enables the monitoring and setting of variable values during the execution of a script.
- SQL in CONTROL
  The database functions enable you to quickly carry out value queries on data points and elements.
- WinCC OA JavaScript Manager for Node.js
  The WinCC OA JavaScript Manager for Node.js is a manager that allows for the integration of the TypeScript/JavaScript runtime environment Node.js® into WinCC OA.
- API Manager
  The WinCC OA API (Application Programming Interface) offers a number of functions adding special Managers to this process control system.
Data Visualization
User interfaces, Trends and Reports for every purpose and device.
Southbound Interfaces
The process connection to the actual machines/sensors.
Northbound Interfaces
Your portal to the cloud or supervising systems.
Web Connectivity / Network Interfaces
Data exchange, APIs and web technologies
User Management
All about authorization, authentication and login-customization.
Availability
How to get your system uptime to the maximum.
Reporting
Create state of the art project reports without limits.
Addons
Useful tools and enhancements for special demands.
Reference Tables
Detailed and extensive content for special project adaptation.
Videos & Tutorials
Explore the capabilities of WinCC OA with our carefully selected collection of video tutorials and guides.
Documentation
Basic information about terms and functions within the documentation.
Support & Services
An experienced team of support agents, consultants and trainers are ready to facilitate active partnerships with our customers, so they can profit from our comprehensive service.
Disclaimer
A brief clarification of liability exclusions or legal notices.

xmlDocumentToString()

Returns the internal DOM tree as a string result.

Synopsis

string xmlDocumentToString(unsigned doc);

Parameters


Parameter	Description
doc	The document ID returned by e.g. xmlNewDocument().

Return value

If an error occurs, an empty string will be returned, otherwise the string result.

Description

Returns the internal DOM tree as a string result.

Example

#uses "CtrlXml"
main()
{
  unsigned doc;
  int ret;
  int rootId;
  int nodeType;
  int childId;
  string nodeTypeText;
  doc = xmlNewDocument();
  DebugN("doc", doc);
  rootId = xmlAppendChild(doc, -1, 1);
  //Node type definition
  nodeType = XML_ATTRIBUTE_NODE;
  nodeTypeText = "Attribute name";
  //Add child
  childId = xmlAppendChild(doc, rootId, nodeType,
  "name_"+nodeTypeText);
  DebugN("xmlAppendChild", nodeTypeText + "(" + nodeType + ")",
  childId);
  //Detect node type
  DebugN("xmlNodeType", childId, nodeTypeText+"("+nodeType+")",
  xmlNodeType(doc, childId));
  //Detect node name
  DebugN("xmlNodeName", childId, nodeTypeText+"("+nodeType+")",
  xmlNodeName(doc, childId));
  //Set value
  DebugN("xmlSetNodeValue", childId, xmlSetNodeValue(doc, childId,
  "Value_"+nodeTypeText));
  //Read value
  DebugN("xmlNodeValue", childId, xmlNodeValue(doc, childId));
  //Add attribute
  DebugN("xmlSetElementAttribute", childId,
  xmlSetElementAttribute(doc, childId, "attrib",
  "att_"+nodeTypeText));
  //Read attribute
  mapping m;
  m = xmlElementAttributes(doc, childId);
  DebugN("xmlSetElementAttribute", childId, m);
  //Write to string
  DebugN("xmlDocumentToString", xmlDocumentToString(doc));
  ret = xmlCloseDocument(doc);
  DebugN(ret);
}

Assignment

XML Control Extension

Availability

CTRL. In every script where the "CtrlXml" extension (#uses "CtrlXml") is used.