InvalidCharacterPosition (XmlDoc function): Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
m (edits, tags and links) |
||
| Line 1: | Line 1: | ||
{{Template:XmlDoc:InvalidCharacterPosition subtitle}} | {{Template:XmlDoc:InvalidCharacterPosition subtitle}} | ||
<var>InvalidCharacterPosition</var> validates whether the characters in a string may be used as the value of an <var>Element</var> or <var>Attribute</var> node. The method checks the characters in its <var class="term">value</var> argument and returns 0 if they are all valid; otherwise, it returns the position of the first invalid character. | |||
==Syntax== | ==Syntax== | ||
{{Template:XmlDoc:InvalidCharacterPosition syntax}} | {{Template:XmlDoc:InvalidCharacterPosition syntax}} | ||
| Line 11: | Line 7: | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>%position</th> | <tr><th>%position</th> | ||
<td>The numeric position of the first character that is '''not''' valid to be used as the value of an Element or Attribute node; otherwise, 0 if all characters are valid. </td></tr> | <td>The numeric position of the first character that is '''not''' valid to be used as the value of an <var>Element</var> or <var>Attribute</var> node; otherwise, 0 if all characters are valid. </td></tr> | ||
<tr><th>%(XmlDoc)</th> | <tr><th>%(XmlDoc)</th> | ||
<td>The class name in parentheses denotes a shared method. <var>InvalidCharacterPosition</var> can also be invoked via an <var>XmlDoc</var> object variable, which may be null.</td></tr> | <td>The class name in parentheses denotes a shared method. <var>InvalidCharacterPosition</var> can also be invoked via an <var>XmlDoc</var> object variable, which may be null.</td></tr> | ||
<tr><th>string</th> | <tr><th>string</th> | ||
<td>The input string whose characters are to be validated. As of | <td>The input string whose characters are to be validated. As of <var class="product">[[Sirius Mods|"Sirius Mods"]]</var> Version 7.6, this may be a <var>Unicode</var> string or an EBCDIC string. Formerly, only EBCDIC was allowed. </td></tr> | ||
<tr><th><var>AllowNull</var></th> | <tr><th><var>AllowNull</var></th> | ||
<td>This | <td>This optional, but <var>[[Methods#Named parameters|Name-Required]]</var>, is a <var>[[Boolean Enumeration]]</var> which determines whether an input null character is considered invalid. | ||
<p>The default value of <var class="term">AllowNull</var> is <code>False</code>, which causes an input null character to be treated as invalid. If <var class="term">AllowNull</var> is <code>True</code>, an input null is valid.</p> | |||
The default value of AllowNull is < | <p> <var class="term">AllowNull</var> is available as of <var class="product">"Sirius Mods"</var> Version 7.6.</p></td></tr> | ||
AllowNull is available as of | |||
</table> | </table> | ||
| Line 28: | Line 22: | ||
<li><var>InvalidCharacterPosition</var> returns zero if its argument string is: | <li><var>InvalidCharacterPosition</var> returns zero if its argument string is: | ||
<ul> | <ul> | ||
<li><var>Unicode</var>, and all characters are legal in an XML document (the only illegal | <li><var>Unicode</var>, and all characters are legal in an XML document (the only illegal character is the null character, if <code>AllowNull=False</code>). | ||
character is the null character, if <code>AllowNull=False</code>). | |||
<li>EBCDIC, and all characters are translatable to <var>Unicode</var> characters (and, if <code>AllowNull=False</code>, there are no null characters). | <li>EBCDIC, and all characters are translatable to <var>Unicode</var> characters (and, if <code>AllowNull=False</code>, there are no null characters). | ||
</ul> | </ul> | ||
Otherwise, it returns the character position of the first character that does not meet these criteria. | |||
Otherwise, it returns the character position of the first character | <p>Prior to <var class="product">[[Sirius Mods|"Sirius Mods"]]</var> Version 7.6, the invalid characters of an <var>Element</var> or <var>Attribute</var> node were the EBCDIC "control characters."</p> | ||
that does not meet these criteria. | <li>With the introduction of this method, the <var>[[IsValidString_(XmlDoc_function)|IsValidString]]</var> function is deprecated. | ||
<li>This method was actually introduced in <var class="product">[[Janus SOAP|"Janus Soap"]]</var> Version 6.9, but its documentation first appeared in Version 7.0. | |||
Prior to | |||
node were the EBCDIC "control characters." | |||
<li>With the introduction of this method, the | |||
deprecated. | |||
<li>This method was actually introduced | |||
first appeared in | |||
</ul> | </ul> | ||
==See also== | ==See also== | ||
{{Template:XmlDoc:InvalidCharacterPosition footer}} | {{Template:XmlDoc:InvalidCharacterPosition footer}} | ||
Revision as of 12:14, 16 May 2011
Detect invalid characters (XmlDoc class)
InvalidCharacterPosition validates whether the characters in a string may be used as the value of an Element or Attribute node. The method checks the characters in its value argument and returns 0 if they are all valid; otherwise, it returns the position of the first invalid character.
Syntax
%position = %(XmlDoc):InvalidCharacterPosition( string, [AllowNull= boolean])
Syntax terms
| %position | The numeric position of the first character that is not valid to be used as the value of an Element or Attribute node; otherwise, 0 if all characters are valid. |
|---|---|
| %(XmlDoc) | The class name in parentheses denotes a shared method. InvalidCharacterPosition can also be invoked via an XmlDoc object variable, which may be null. |
| string | The input string whose characters are to be validated. As of "Sirius Mods" Version 7.6, this may be a Unicode string or an EBCDIC string. Formerly, only EBCDIC was allowed. |
| AllowNull | This optional, but Name-Required, is a Boolean Enumeration which determines whether an input null character is considered invalid.
The default value of AllowNull is AllowNull is available as of "Sirius Mods" Version 7.6. |
Usage notes
- InvalidCharacterPosition returns zero if its argument string is:
- Unicode, and all characters are legal in an XML document (the only illegal character is the null character, if
AllowNull=False). - EBCDIC, and all characters are translatable to Unicode characters (and, if
AllowNull=False, there are no null characters).
Otherwise, it returns the character position of the first character that does not meet these criteria.
Prior to "Sirius Mods" Version 7.6, the invalid characters of an Element or Attribute node were the EBCDIC "control characters."
- Unicode, and all characters are legal in an XML document (the only illegal character is the null character, if
- With the introduction of this method, the IsValidString function is deprecated.
- This method was actually introduced in "Janus Soap" Version 6.9, but its documentation first appeared in Version 7.0.