CONTROL
- Introduction to CTRL
- Control Classes
- Types of Control Functions
- Control graphics
- CONTROL Functions
  - Funtions A
  - Funtions B
  - Funtions C
  - Funtions 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, basics
- 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.

xmlDocumentFromFile()

Opens a file and reads the complete content building the DOM structure in memory.

Synopsis

int xmlDocumentFromFile(string fileName, string &errMsg, int &errLine, int &errColumn);

Parameters


Parameter	Description
fileName	Absolute path to the file which shall be opened.
errMsg	Alert message of the failure.
errLine	Line in the document where the failure occurred.
errColumn	Column in the document where the failure occurred.

Return value

Returns a document ID which will be passed in future other XML calls.

If an error occurs, -1 will be returned.

Description

Opens a file and reads the complete content building the DOM structure in memory. Returns a document identifier which will be passed in future other XML calls. The returned ID is valid until a call of xmlCloseDocument().

In case of an error, errMsg, errLine, errColumn contain a reference to the position where the parsing failed.

Example

#uses "CtrlXml"
main() 
{
  int Id;
  string fileName = "c:/XmlTest.xml";
  string errMsg;
  int errLine, errColumn;
  Id = xmlDocumentFromFile(fileName, errMsg, errLine,
  errColumn);
  DebugN("The ID:", Id);
  DebugN("Errors:", errMsg, errLine, errColumn);
}

Assignment

XML Control Extension

Availability

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