Note: This is the migration API reference for FAKE 5. The new (modularized) API documentation can be found here. If the API is already migrated you can check here if exists in a module. More information regarding the migration can be found here

OBSOLETE

Use Fake.Core.Xml instead (open Fake.Core and use 'Xml.<name>' instead of directly calling Xml<name> - ie add a dot)

XMLHelper

Contains functions to read and write XML files.

Functions and values

Function or valueDescription
DocElement(doc)
Signature: doc:XmlDocument -> XmlElement
Attributes:
[<Obsolete("Use Fake.Core.Xml instead (open Fake.Core and use 'Xml.<name>' instead of directly calling Xml<name> - ie add a dot)")>]
OBSOLETE

Use Fake.Core.Xml instead (open Fake.Core and use 'Xml.<name>' instead of directly calling Xml<name> - ie add a dot)

Gets the DocumentElement of the XmlDocument
getAttribute name node
Signature: name:string -> node:'a -> string
Type parameters: 'a Attributes:
[<Obsolete("Use Fake.Core.Xml instead (open Fake.Core and use 'Xml.<name>' instead of directly calling Xml<name> - ie add a dot)")>]
OBSOLETE

Use Fake.Core.Xml instead (open Fake.Core and use 'Xml.<name>' instead of directly calling Xml<name> - ie add a dot)

Gets the attribute with the given name from the given XmlNode
getChilds(node)
Signature: node:'a -> seq<XmlNode>
Type parameters: 'a Attributes:
[<Obsolete("Use Fake.Core.Xml instead (open Fake.Core and use 'Xml.<name>' instead of directly calling Xml<name> - ie add a dot)")>]
OBSOLETE

Use Fake.Core.Xml instead (open Fake.Core and use 'Xml.<name>' instead of directly calling Xml<name> - ie add a dot)

Gets a sequence of all child nodes for the given XmlNode
getSubNode name node
Signature: name:string -> node:XmlNode -> XmlNode
Attributes:
[<Obsolete("Use Fake.Core.Xml instead (open Fake.Core and use 'Xml.<name>' instead of directly calling Xml<name> - ie add a dot)")>]
OBSOLETE

Use Fake.Core.Xml instead (open Fake.Core and use 'Xml.<name>' instead of directly calling Xml<name> - ie add a dot)

Gets the first sub node with the given name from the given XmlNode
parse name f node
Signature: name:string -> f:('a -> 'b) -> node:'a -> 'b
Type parameters: 'a, 'b Attributes:
[<Obsolete("Use Fake.Core.Xml instead (open Fake.Core and use 'Xml.<name>' instead of directly calling Xml<name> - ie add a dot)")>]
OBSOLETE

Use Fake.Core.Xml instead (open Fake.Core and use 'Xml.<name>' instead of directly calling Xml<name> - ie add a dot)

Parses a XmlNode
parseSubNode name f
Signature: name:string -> f:(XmlNode -> 'a) -> XmlNode -> 'a
Type parameters: 'a Attributes:
[<Obsolete("Use Fake.Core.Xml instead (open Fake.Core and use 'Xml.<name>' instead of directly calling Xml<name> - ie add a dot)")>]
OBSOLETE

Use Fake.Core.Xml instead (open Fake.Core and use 'Xml.<name>' instead of directly calling Xml<name> - ie add a dot)

Parses a XML subnode
XmlAttribute name value writer
Signature: name:string -> value:'?13420 -> writer:XmlTextWriter -> XmlTextWriter
Type parameters: '?13420 Attributes:
[<Obsolete("Use Fake.Core.Xml instead (open Fake.Core and use 'Xml.<name>' instead of directly calling Xml<name> - ie add a dot)")>]
OBSOLETE

Use Fake.Core.Xml instead (open Fake.Core and use 'Xml.<name>' instead of directly calling Xml<name> - ie add a dot)

Writes an XML attribute to current element of the given XmlTextWriter
XmlCDataElement elementName data writer
Signature: elementName:string -> data:string -> writer:XmlTextWriter -> XmlTextWriter
Attributes:
[<Obsolete("Use Fake.Core.Xml instead (open Fake.Core and use 'Xml.<name>' instead of directly calling Xml<name> - ie add a dot)")>]
OBSOLETE

Use Fake.Core.Xml instead (open Fake.Core and use 'Xml.<name>' instead of directly calling Xml<name> - ie add a dot)

Writes an CData element to the given XmlTextWriter
XmlComment comment writer
Signature: comment:string -> writer:XmlTextWriter -> XmlTextWriter
Attributes:
[<Obsolete("Use Fake.Core.Xml instead (open Fake.Core and use 'Xml.<name>' instead of directly calling Xml<name> - ie add a dot)")>]
OBSOLETE

Use Fake.Core.Xml instead (open Fake.Core and use 'Xml.<name>' instead of directly calling Xml<name> - ie add a dot)

Writes an XML comment to the given XmlTextWriter
XMLDoc(text)
Signature: text:string -> XmlDocument
Attributes:
[<Obsolete("Use Fake.Core.Xml instead (open Fake.Core and use 'Xml.<name>' instead of directly calling Xml<name> - ie add a dot)")>]
OBSOLETE

Use Fake.Core.Xml instead (open Fake.Core and use 'Xml.<name>' instead of directly calling Xml<name> - ie add a dot)

Loads the given text into a XmlDocument
XmlEndElement(writer)
Signature: writer:XmlTextWriter -> XmlTextWriter
Attributes:
[<Obsolete("Use Fake.Core.Xml instead (open Fake.Core and use 'Xml.<name>' instead of directly calling Xml<name> - ie add a dot)")>]
OBSOLETE

Use Fake.Core.Xml instead (open Fake.Core and use 'Xml.<name>' instead of directly calling Xml<name> - ie add a dot)

Writes an XML end element to the given XmlTextWriter
XmlPoke fileName xpath value
Signature: fileName:string -> xpath:string -> value:string -> unit
Attributes:
[<Obsolete("Use Fake.Core.Xml instead (open Fake.Core and use 'Xml.<name>' instead of directly calling Xml<name> - ie add a dot)")>]
OBSOLETE

Use Fake.Core.Xml instead (open Fake.Core and use 'Xml.<name>' instead of directly calling Xml<name> - ie add a dot)

Replaces text in a XML file at the location specified by a XPath expression.
XmlPokeInnerText(...)
Signature: fileName:string -> xpath:string -> innerTextValue:string -> unit
Attributes:
[<Obsolete("Use Fake.Core.Xml instead (open Fake.Core and use 'Xml.<name>' instead of directly calling Xml<name> - ie add a dot)")>]
OBSOLETE

Use Fake.Core.Xml instead (open Fake.Core and use 'Xml.<name>' instead of directly calling Xml<name> - ie add a dot)

Replaces the inner text of an xml node in a XML file at the location specified by a XPath expression.
XmlPokeInnerTextNS(...)
Signature: fileName:string -> namespaces:seq<string * string> -> xpath:string -> innerTextValue:string -> unit
Attributes:
[<Obsolete("Use Fake.Core.Xml instead (open Fake.Core and use 'Xml.<name>' instead of directly calling Xml<name> - ie add a dot)")>]
OBSOLETE

Use Fake.Core.Xml instead (open Fake.Core and use 'Xml.<name>' instead of directly calling Xml<name> - ie add a dot)

Replaces inner text of an xml node in a XML file at the location specified by a XPath expression, with support for namespaces.
XmlPokeNS(...)
Signature: fileName:string -> namespaces:seq<string * string> -> xpath:string -> value:string -> unit
Attributes:
[<Obsolete("Use Fake.Core.Xml instead (open Fake.Core and use 'Xml.<name>' instead of directly calling Xml<name> - ie add a dot)")>]
OBSOLETE

Use Fake.Core.Xml instead (open Fake.Core and use 'Xml.<name>' instead of directly calling Xml<name> - ie add a dot)

Replaces text in a XML file at the location specified by a XPath expression, with support for namespaces.
XMLRead(...)
Signature: failOnError:bool -> xmlFileName:string -> nameSpace:string -> prefix:string -> xPath:string -> seq<string>
Attributes:
[<Obsolete("Use Fake.Core.Xml instead (open Fake.Core and use 'Xml.<name>' instead of directly calling Xml<name> - ie add a dot)")>]
OBSOLETE

Use Fake.Core.Xml instead (open Fake.Core and use 'Xml.<name>' instead of directly calling Xml<name> - ie add a dot)

Reads a value from a XML document using a XPath
XMLRead_Int(...)
Signature: failOnError:bool -> xmlFileName:string -> nameSpace:string -> prefix:string -> xPath:string -> bool * int
Attributes:
[<Obsolete("Use Fake.Core.Xml instead (open Fake.Core and use 'Xml.<name>' instead of directly calling Xml<name> - ie add a dot)")>]
OBSOLETE

Use Fake.Core.Xml instead (open Fake.Core and use 'Xml.<name>' instead of directly calling Xml<name> - ie add a dot)

Reads a value from a XML document using a XPath Returns if the value is an int and the value
XmlStartElement name writer
Signature: name:string -> writer:XmlTextWriter -> XmlTextWriter
Attributes:
[<Obsolete("Use Fake.Core.Xml instead (open Fake.Core and use 'Xml.<name>' instead of directly calling Xml<name> - ie add a dot)")>]
OBSOLETE

Use Fake.Core.Xml instead (open Fake.Core and use 'Xml.<name>' instead of directly calling Xml<name> - ie add a dot)

Writes an XML start element to the given XmlTextWriter
XmlTransform stylesheetUri fileName
Signature: stylesheetUri:string -> fileName:string -> unit
Attributes:
[<Obsolete("Use Fake.Core.Xml instead (open Fake.Core and use 'Xml.<name>' instead of directly calling Xml<name> - ie add a dot)")>]
OBSOLETE

Use Fake.Core.Xml instead (open Fake.Core and use 'Xml.<name>' instead of directly calling Xml<name> - ie add a dot)

Transforms a XML file using a XSL stylesheet file.

Parameters

  • stylesheetUri - The Uri for the XSL stylesheet file.
  • fileName - The XML file to transform.
XmlWriter(fileName)
Signature: fileName:string -> XmlTextWriter
Attributes:
[<Obsolete("Use Fake.Core.Xml instead (open Fake.Core and use 'Xml.<name>' instead of directly calling Xml<name> - ie add a dot)")>]
OBSOLETE

Use Fake.Core.Xml instead (open Fake.Core and use 'Xml.<name>' instead of directly calling Xml<name> - ie add a dot)

Creates a XmlWriter which writes to the given file name
XPathReplace xpath value doc
Signature: xpath:string -> value:string -> doc:XmlDocument -> XmlDocument
Attributes:
[<Obsolete("Use Fake.Core.Xml instead (open Fake.Core and use 'Xml.<name>' instead of directly calling Xml<name> - ie add a dot)")>]
OBSOLETE

Use Fake.Core.Xml instead (open Fake.Core and use 'Xml.<name>' instead of directly calling Xml<name> - ie add a dot)

Replaces text in the XML document specified by a XPath expression.
XPathReplaceInnerText(...)
Signature: xpath:string -> innerTextValue:string -> doc:XmlDocument -> XmlDocument
Attributes:
[<Obsolete("Use Fake.Core.Xml instead (open Fake.Core and use 'Xml.<name>' instead of directly calling Xml<name> - ie add a dot)")>]
OBSOLETE

Use Fake.Core.Xml instead (open Fake.Core and use 'Xml.<name>' instead of directly calling Xml<name> - ie add a dot)

Replaces the inner text of an xml node in the XML document specified by a XPath expression.
XPathReplaceInnerTextNS(...)
Signature: xpath:string -> innerTextValue:string -> namespaces:'?13443 -> doc:XmlDocument -> XmlDocument
Type parameters: '?13443 Attributes:
[<Obsolete("Use Fake.Core.Xml instead (open Fake.Core and use 'Xml.<name>' instead of directly calling Xml<name> - ie add a dot)")>]
OBSOLETE

Use Fake.Core.Xml instead (open Fake.Core and use 'Xml.<name>' instead of directly calling Xml<name> - ie add a dot)

Replaces inner text in a XML document specified by a XPath expression, with support for namespaces.
XPathReplaceNS(...)
Signature: xpath:string -> value:string -> namespaces:'?13441 -> doc:XmlDocument -> XmlDocument
Type parameters: '?13441 Attributes:
[<Obsolete("Use Fake.Core.Xml instead (open Fake.Core and use 'Xml.<name>' instead of directly calling Xml<name> - ie add a dot)")>]
OBSOLETE

Use Fake.Core.Xml instead (open Fake.Core and use 'Xml.<name>' instead of directly calling Xml<name> - ie add a dot)

Replaces text in a XML document specified by a XPath expression, with support for namespaces.
XPathValue xpath namespaces doc
Signature: xpath:string -> namespaces:'a -> doc:XmlDocument -> string
Type parameters: 'a Attributes:
[<Obsolete("Use Fake.Core.Xml instead (open Fake.Core and use 'Xml.<name>' instead of directly calling Xml<name> - ie add a dot)")>]
OBSOLETE

Use Fake.Core.Xml instead (open Fake.Core and use 'Xml.<name>' instead of directly calling Xml<name> - ie add a dot)

Selects a xml node value via XPath from the given document
XslTransform xsl doc
Signature: xsl:XslCompiledTransform -> doc:XmlDocument -> XmlDocument
Attributes:
[<Obsolete("Use Fake.Core.Xml instead (open Fake.Core and use 'Xml.<name>' instead of directly calling Xml<name> - ie add a dot)")>]
OBSOLETE

Use Fake.Core.Xml instead (open Fake.Core and use 'Xml.<name>' instead of directly calling Xml<name> - ie add a dot)

Transforms a XmlDocument using a XslCompiledTransform.

Parameters

  • xsl - The XslCompiledTransform which should be applied.
  • doc - The XmlDocument to transform.
XslTransformer(text)
Signature: text:string -> XslCompiledTransform
Attributes:
[<Obsolete("Use Fake.Core.Xml instead (open Fake.Core and use 'Xml.<name>' instead of directly calling Xml<name> - ie add a dot)")>]
OBSOLETE

Use Fake.Core.Xml instead (open Fake.Core and use 'Xml.<name>' instead of directly calling Xml<name> - ie add a dot)

Loads the given text into a XslCompiledTransform.