InvalidCharacterPosition (XmlDoc function)

From m204wiki
Jump to navigation Jump to search
The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.

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 string argument and returns 0 if they are all valid; otherwise, it returns the position of the first invalid character.


%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, name required, argument is a Boolean enumeration that determines whether an input null character is considered invalid.

The default value of AllowNull is False, which causes an input null character to be treated as invalid. If AllowNull is True, an input null is valid.

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."

  • With the introduction of this method, the IsValidString function is deprecated.

See also