XmlDoc methods syntax: Difference between revisions
(Automatically generated page update) |
(Automatically generated page update) |
||
| (2 intermediate revisions by one other user not shown) | |||
| Line 47: | Line 47: | ||
Throws [[XPathError class|XPathError]]</p> | Throws [[XPathError class|XPathError]]</p> | ||
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">doc</span><span class="literal">:[[LoadChangedRecords (XmlDoc subroutine)|LoadChangedRecords]]</span><span class="squareb">[</span><span class="literal">(</span> <span class="squareb">[</span><span class="literal" title="Boolean">Fields=</span> <span class="term" title="Boolean">boolean</span><span class="squareb">]</span><span class="literal">)</span><span class="squareb">]</span></p> | |||
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">doc</span><span class="literal">:[[LoadCommandInfo (XmlDoc subroutine)|LoadCommandInfo]]</span><span class="squareb">[</span><span class="literal">(</span> <span class="squareb">[</span><span class="term" title="String">string</span><span class="squareb">]</span><span class="literal">)</span><span class="squareb">]</span></p> | <p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">doc</span><span class="literal">:[[LoadCommandInfo (XmlDoc subroutine)|LoadCommandInfo]]</span><span class="squareb">[</span><span class="literal">(</span> <span class="squareb">[</span><span class="term" title="String">string</span><span class="squareb">]</span><span class="literal">)</span><span class="squareb">]</span></p> | ||
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">nr</span><span class="literal">:[[LoadFromRecord (XmlDoc/XmlNode subroutine)|LoadFromRecord]]</span><span class="squareb">[</span><span class="literal">(</span> <span class="squareb">[</span><span class="literal" title="Boolean">AttributeValues=</span> <span class="term" title="Boolean">boolean</span><span class="squareb">]</span><span class="comma">,</span> <span class="squareb">[</span><span class="literal" title="Boolean">AttributeNames=</span> <span class="term" title="Boolean">boolean</span><span class="squareb">]</span><span class="comma">,</span> - | <p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">nr</span><span class="literal">:[[LoadFromRecord (XmlDoc/XmlNode subroutine)|LoadFromRecord]]</span><span class="squareb">[</span><span class="literal">(</span> <span class="squareb">[</span><span class="literal" title="Boolean">AttributeValues=</span> <span class="term" title="Boolean">boolean</span><span class="squareb">]</span><span class="comma">,</span> <span class="squareb">[</span><span class="literal" title="Boolean">AttributeNames=</span> <span class="term" title="Boolean">boolean</span><span class="squareb">]</span><span class="comma">,</span> - | ||
<span class="squareb">[</span><span class="literal" title="Boolean">NamesToLower=</span> <span class="term" title="Boolean">boolean</span><span class="squareb">]</span><span class="comma">,</span> <span class="squareb">[</span><span class="literal" title="Boolean">AllowUnreversible=</span> <span class="term" title="Boolean">boolean</span><span class="squareb">]</span><span class="comma">,</span> - | <span class="squareb">[</span><span class="literal" title="Boolean">NamesToLower=</span> <span class="term" title="Boolean">boolean</span><span class="squareb">]</span><span class="comma">,</span> <span class="squareb">[</span><span class="literal" title="Boolean">AllowUnreversible=</span> <span class="term" title="Boolean">boolean</span><span class="squareb">]</span><span class="comma">,</span> - | ||
<span class="squareb">[</span><span class="literal" title="Boolean">CodepageTable=</span> <span class="term" title="Boolean">boolean</span><span class="squareb">]</span><span class="comma">,</span> <span class="squareb">[</span><span class="literal" title="Boolean">Base64Encode=</span> <span class="term" title="Boolean">boolean</span><span class="squareb">]</span><span class="comma">,</span> - | <span class="squareb">[</span><span class="literal" title="Boolean">CodepageTable=</span> <span class="term" title="Boolean">boolean</span><span class="squareb">]</span><span class="comma">,</span> <span class="squareb">[</span><span class="literal" title="Boolean">Base64Encode=</span> <span class="term" title="Boolean">boolean</span><span class="squareb">]</span><span class="comma">,</span> - | ||
<span class="squareb">[</span><span class="literal" title="CharacterToUnicodeMap">CharacterMap=</span> <span class="term" title="CharacterToUnicodeMap">characterToUnicodeMap</span><span class="squareb">]</span><span class="literal">)</span><span class="squareb">]</span> | <span class="squareb">[</span><span class="literal" title="CharacterToUnicodeMap">CharacterMap=</span> <span class="term" title="CharacterToUnicodeMap">characterToUnicodeMap</span><span class="squareb">]</span><span class="comma">,</span> <span class="squareb">[</span><span class="literal" title="Boolean">Header=</span> <span class="term" title="Boolean">boolean</span><span class="squareb">]</span><span class="comma">,</span> - | ||
<span class="squareb">[</span><span class="literal" title="Number">Recordnumber=</span> <span class="term" title="Number">number</span><span class="squareb">]</span><span class="comma">,</span> <span class="squareb">[</span><span class="literal" title="String">File=</span> <span class="term" title="String">string</span><span class="squareb">]</span><span class="literal">)</span><span class="squareb">]</span> | |||
Throws [[CharacterTranslationException class|CharacterTranslationException]]</p> | Throws [[CharacterTranslationException class|CharacterTranslationException]]</p> | ||
| Line 58: | Line 60: | ||
Throws [[XmlParseError class|XmlParseError]]</p> | Throws [[XmlParseError class|XmlParseError]]</p> | ||
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">doc</span><span class="literal">:[[LoadMessageInfo (XmlDoc subroutine)|LoadMessageInfo]]</span><span class="squareb">[</span><span class="literal">(</span> <span class="squareb">[</span><span class="term" title="String">string</span><span class="squareb">]</span><span class="literal">)</span><span class="squareb">]</span></p> | <p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">doc</span><span class="literal">:[[LoadMessageInfo (XmlDoc subroutine)|LoadMessageInfo]]</span><span class="squareb">[</span><span class="literal">(</span> <span class="squareb">[</span><span class="term" title="String">string</span><span class="squareb">]</span><span class="literal">)</span><span class="squareb">]</span></p> | ||
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">doc</span><span class="literal">:[[LoadMsgctl (XmlDoc subroutine)|LoadMsgctl]]</span><span class="squareb">[</span><span class="literal">(</span> <span class="squareb">[</span><span class="literal" title="String">EDEFHD=</span> <span class="term" title="String">forRocketSupport</span><span class="squareb">]</span><span class="literal">)</span><span class="squareb">]</span></p> | |||
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">doc</span><span class="literal">:[[LoadParameterInfo (XmlDoc subroutine)|LoadParameterInfo]]</span><span class="squareb">[</span><span class="literal">(</span> <span class="squareb">[</span><span class="term" title="String">string</span><span class="squareb">]</span><span class="literal">)</span><span class="squareb">]</span></p> | <p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">doc</span><span class="literal">:[[LoadParameterInfo (XmlDoc subroutine)|LoadParameterInfo]]</span><span class="squareb">[</span><span class="literal">(</span> <span class="squareb">[</span><span class="term" title="String">string</span><span class="squareb">]</span><span class="literal">)</span><span class="squareb">]</span></p> | ||
<p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">doc</span><span class="literal">:[[LoadSystemMethodInfo (XmlDoc subroutine)|LoadSystemMethodInfo]]</span><span class="literal">(</span> <span class="term" title="String">pattern</span><span class="comma">,</span> <span class="squareb">[</span><span class="literal" title="Boolean">ShowBase=</span> <span class="term" title="Boolean">boolean</span><span class="squareb">]</span><span class="literal">)</span></p> | <p class="syntax" style="margin-bottom:0px; border-bottom:1px solid; border-left:1px solid; border-right:1px solid; border-top: none; margin-top:0px;"><span class="term">doc</span><span class="literal">:[[LoadSystemMethodInfo (XmlDoc subroutine)|LoadSystemMethodInfo]]</span><span class="literal">(</span> <span class="term" title="String">pattern</span><span class="comma">,</span> <span class="squareb">[</span><span class="literal" title="Boolean">ShowBase=</span> <span class="term" title="Boolean">boolean</span><span class="squareb">]</span><span class="literal">)</span></p> | ||
| Line 76: | Line 79: | ||
<span class="squareb">[</span><span class="literal" title="Boolean">Base64Encode=</span> <span class="term" title="Boolean">boolean</span><span class="squareb">]</span><span class="comma">,</span> - | <span class="squareb">[</span><span class="literal" title="Boolean">Base64Encode=</span> <span class="term" title="Boolean">boolean</span><span class="squareb">]</span><span class="comma">,</span> - | ||
<span class="squareb">[</span><span class="literal" title="CharacterToUnicodeMap">CharacterMap=</span> <span class="term" title="CharacterToUnicodeMap">characterToUnicodeMap</span><span class="squareb">]</span><span class="comma">,</span> - | <span class="squareb">[</span><span class="literal" title="CharacterToUnicodeMap">CharacterMap=</span> <span class="term" title="CharacterToUnicodeMap">characterToUnicodeMap</span><span class="squareb">]</span><span class="comma">,</span> - | ||
<span class="squareb">[</span><span class="literal" title="Boolean"> | <span class="squareb">[</span><span class="literal" title="Boolean">Allownull=</span> <span class="term" title="Boolean">boolean</span><span class="squareb">]</span><span class="comma">,</span> - | ||
<span class="squareb">[</span><span class="literal" title="Number">Recordnumber=</span> <span class="term" title="Number">number</span><span class="squareb">]</span><span class="comma">,</span> <span class="squareb">[</span><span class="literal" title="String">File=</span> <span class="term" title="String">string</span><span class="squareb">]</span><span class="literal">)</span><span class="squareb">]</span> | |||
Throws [[CharacterTranslationException class|CharacterTranslationException]]</p> | Throws [[CharacterTranslationException class|CharacterTranslationException]]</p> | ||
Latest revision as of 03:55, 15 January 2020
The syntax for each of the XmlDoc class methods is shown below.
Square brackets indicate optional elements of the method invocation. See also the notation conventions for methods and the List of XmlDoc methods.
[%nod =] nr:AddComment( value)
[%nod =] nr:AddElement( name, [value], [uri])
[%nod =] nr:AddPI( name, value)
[%nod =] nr:AddSubtree( sourceSubtreeNode, [DefaultURI= unicode])
[%nod =] doc:AddTopElement( name, [uri], [MoveNamespace= boolean])
doc:AddToRecord[( [DisableFieldConstraints= boolean], [CopyIDs= boolean], - [IgnoreUndefinedFields= boolean])] Throws AddToRecordError
%currentXmlAdjacentTextSetting = doc:AdjacentText doc:AdjacentText = newXmlAdjacentTextSetting
%currentBoolean = doc:AllowNull doc:AllowNull = newBoolean
%currentBoolean = doc:AllowXmlAttribute doc:AllowXmlAttribute = newBoolean
%currentBoolean = doc:AllowXmlElement doc:AllowXmlElement = newBoolean
nr:Audit[( [xpath], [options])] Throws XPathError
%doc = [%(XmlDoc):]ClientCertificate[( [AttributeValues= boolean], - [AttributeNames= boolean])]
%outDoc = doc:Copy
%outDoc = doc:DeepCopy
%unicode = nr:DefaultURI[( [xpath])] Throws XPathError
doc:DeleteSelectionPrefix( prefix)
nr:DeleteSubtree[( [xpath])] Throws XPathError
doc:DeleteTopElement
%currentString = doc:Encoding doc:Encoding = newString
%boolean = nr:Exists( xpath) Throws XPathError
%currentXmlInvalidChar = doc:InvalidChar doc:InvalidChar = newXmlInvalidChar
%position = %(XmlDoc):InvalidCharacterPosition( string, [AllowNull= boolean])
%boolean = doc:IsSelectionPrefix( prefix)
%boolean = %(XmlDoc):IsValidString( string, [AllowNull= boolean])
%number = nr:Length[( [xpath])] Throws XPathError
doc:LoadChangedRecords[( [Fields= boolean])]
doc:LoadCommandInfo[( [string])]
nr:LoadFromRecord[( [AttributeValues= boolean], [AttributeNames= boolean], - [NamesToLower= boolean], [AllowUnreversible= boolean], - [CodepageTable= boolean], [Base64Encode= boolean], - [CharacterMap= characterToUnicodeMap], [Header= boolean], - [Recordnumber= number], [File= string])] Throws CharacterTranslationException
[%number =] nr:LoadFromStringlist( sl, [string]) Throws XmlParseError
doc:LoadMessageInfo[( [string])]
doc:LoadMsgctl[( [EDEFHD= forRocketSupport])]
doc:LoadParameterInfo[( [string])]
doc:LoadSystemMethodInfo( pattern, [ShowBase= boolean])
[%errorPosition =] nr:LoadXml( input, [options]) Throws XmlParseError
%unicode = nr:LocalName[( [xpath])] Throws XPathError
%currentXmlNamespaceSetting = doc:Namespace doc:Namespace = newXmlNamespaceSetting
%doc = [%(XmlDoc):]New
%doc = [%(XmlDoc):]NewFromRecord[( [AttributeValues= boolean], - [AttributeNames= boolean], - [NamesToLower= boolean], - [AllowUnreversible= boolean], - [CodepageTable= boolean], - [Base64Encode= boolean], - [CharacterMap= characterToUnicodeMap], - [Allownull= boolean], - [Recordnumber= number], [File= string])] Throws CharacterTranslationException
%unicode = nr:Prefix[( [xpath])] Throws XPathError
%unicode = nr:PrefixURI( prefix, [xpath]) Throws XPathError
nr:Print[( [xpath], [options])] Throws XPathError
%unicode = nr:QName[( [xpath])] Throws XPathError
%number = nr:SelectCount( xpath) Throws XPathError
%currentUnicode = doc:SelectionNamespace( prefix) doc:SelectionNamespace( prefix) = newUnicode
%nodl = nr:SelectNodes[( [xpath])] Throws XPathError
%nod = nr:SelectSingleNode[( [xpath])] Throws XPathError
%string = nr:Serial[( [xpath], [options], [AddTrailingDelimiter= boolean])] Throws XPathError
%currentString = doc:Standalone doc:Standalone = newString
%string = nr:ToXPathString[( [selectionXpath])] Throws XPathError
%sl = nr:ToXPathStringlist[( [selectionXpath])] Throws XPathError
nr:Trace[( [xpath], [options])] Throws XPathError
%xmlNodeType = nr:Type[( [xpath])] Throws XPathError
%unicode = nr:URI[( [xpath])] Throws XPathError
%currentUnicode = nr:Value[( [xpath])] nr:Value[( [xpath])] = newUnicode Throws XPathError
%unicode = nr:ValueDefault[( [xpath], [value])] Throws XPathError
%currentString = doc:Version doc:Version = newString
[%errorPosition =] doc:WebReceive[( [formFieldname], [fieldOccurrence], - [options])] Throws XmlParseError
doc:WebSend[( [options])]
%string = doc:Xml[( [options])]
%sl = nr:XPathNodeID[( [selectionXpath])] Throws XPathError