IsValidString (XmlDoc function) - Revision history

JAL: /* Request-Cancellation Errors */

2014-09-03T00:04:00Z

Request-Cancellation Errors

← Older revision		Revision as of 00:04, 3 September 2014
Line 65:		Line 65:
	</ul>		</ul>

	[[Category:XmlDoc methods\| IsValidString obsolete shared function]]		[[Category:XmlDoc methods\|IsValidString obsolete shared function]]
	[[Category:XmlDoc API methods]]		[[Category:XmlDoc API methods]]

JAL at 23:42, 2 September 2014

2014-09-02T23:42:26Z

← Older revision		Revision as of 23:42, 2 September 2014
Line 1:		Line 1:
	<span style="font-size:120%; color:black"><b>Valid XML Element/Attribute value?</b></span>		<span style="font-size:120%; color:black"><b>Valid XML Element/Attribute value?</b></span>
	~~[[Category:XmlDoc methods\|IsValidString obsolete shared function]]~~
	~~[[Category:XmlDoc API methods]]~~
	<!--DPL?? Category:XmlDoc methods\|IsValidString obsolete shared function: Valid XML Element/Attribute value?-->		<!--DPL?? Category:XmlDoc methods\|IsValidString obsolete shared function: Valid XML Element/Attribute value?-->
	<!--DPL?? Category:XmlDoc API methods\|IsValidString (obsolete shared XmlDoc function): Valid XML Element/Attribute value?-->		<!--DPL?? Category:XmlDoc API methods\|IsValidString (obsolete shared XmlDoc function): Valid XML Element/Attribute value?-->
Line 65:		Line 64:
	<li><var>IsValidString</var> has no request cancellation errors.		<li><var>IsValidString</var> has no request cancellation errors.
	</ul>		</ul>

			[[Category:XmlDoc methods\| IsValidString obsolete shared function]]
			[[Category:XmlDoc API methods]]

JAL at 19:00, 21 February 2014

2014-02-21T19:00:56Z

← Older revision		Revision as of 19:00, 21 February 2014
Line 6:		Line 6:
	<!--DPL?? Category:System methods\|IsValidString (obsolete shared XmlDoc function): Valid XML Element/Attribute value?-->		<!--DPL?? Category:System methods\|IsValidString (obsolete shared XmlDoc function): Valid XML Element/Attribute value?-->
	<p>		<p>
	IsValidString is a member of the [[XmlDoc class]].		<var>IsValidString</var> is a member of the [[XmlDoc class]].
	</p>		</p>

	This shared function determines whether a string value		This shared function determines whether a string value
	is a valid XML Element or Attribute value.		is a valid XML Element or Attribute value.
	Designed to be used prior to updating an XmlDoc, this function was new		Designed to be used prior to updating an <var>XmlDoc</var>, this function was new
	as of version 6.8 of <var class="product">Sirius Mods</var> and deprecated in favor of [[InvalidCharacterPosition (XmlDoc function)\|InvalidCharacterPosition]] in version 7.0.		as of version 6.8 of <var class="product">Sirius Mods</var> and <b><i>deprecated in favor of <var>[[InvalidCharacterPosition (XmlDoc function)\|InvalidCharacterPosition]]</var></i></b> in version 7.0.
	===Syntax===
	%bool = %(XmlDoc):IsValidString(value)		==Syntax==
	====Syntax Terms====		<p class="syntax"><span class="term">%bool</span> = <span class="literal">%(XmlDoc)</span>:<span class="literal">IsValidString</span>(<span class="term">value</span>)</p>
	<dl>
	<~~dt><i~~><b>%bool</~~b></i~~>		===Syntax Terms===
	<dd>A declared enumeration object of type Boolean to contain the returned value		<table>
	(<tt>True</tt> or <tt>False</tt>) of IsValidString.		<tr><th>%bool</th>
	For more information about enumerations, see [[Enumerations]].		<td>A declared enumeration object of type Boolean to contain the returned value
	<dt>%(XmlDoc)		(<var>True</var> or <var>False</var>) of <var>IsValidString</var>.
	<dd>The class name in parentheses denotes a shared method;		For more information about enumerations, see [[Enumerations]].</td></tr>

			<tr><th><var class="nobr">%(XmlDoc)</var></th>
			<td>The class name in parentheses denotes a shared method;
	you may instead provide an XmlDoc object expression (for example, a %variable).		you may instead provide an XmlDoc object expression (for example, a %variable).
	For more information about shared methods, see [[??]] refid=shared..		For more information about shared methods, see [[??]] refid=shared..</td></tr>
	<dt><i><b>~~value~~</b></i>
	<dd>The input string whose characters are to be validated.		<tr><th>value</th>
			<td>The input string whose characters are to be validated.
	As of <var class="product">Sirius Mods</var> version 7.6, this may be a Unicode string or an EBCDIC string.		As of <var class="product">Sirius Mods</var> version 7.6, this may be a Unicode string or an EBCDIC string.
	Formerly, only EBCDIC was allowed.		Formerly, only EBCDIC was allowed.</td></tr>
			</table>

	~~</dl>~~		==Usage Notes==
	===Usage Notes===
	<ul>		<ul>
	<li>IsValidString returns <tt>True</tt> if its argument string is:		<li><var>IsValidString</var> returns <var>True</var> if its argument string is:
	<ul>		<ul>
	<li>Unicode, and all characters are legal in an Element or Attribute value		<li>Unicode, and all characters are legal in an Element or Attribute value
Line 41:		Line 45:
	</ul>		</ul>

	Otherwise, it returns <tt>False</tt>.		Otherwise, it returns <var>False</var>.

	Prior to <var class="product">Sirius Mods</var> 7.6, the invalid characters of an Element or Attribute		Prior to <var class="product">Sirius Mods</var> 7.6, the invalid characters of an Element or Attribute
	node were the EBCDIC ~~“~~control characters.~~”~~		node were the EBCDIC "control characters."
	<li>If the result of the IsValidString call is <tt>True</tt>:		<li>If the result of the <var>IsValidString</var> call is <var>True</var>:
	<ul>		<ul>
	<li>The AddAttribute, AddElement, AddText, InsertTextBefore,		<li>The <var>AddAttribute</var>, <var>AddElement</var>, <var>AddText</var>, <var>InsertTextBefore</var>,
	and InsertElementBefore functions may use the		and <var>InsertElementBefore</var> functions may use the
	''value'' string as their second argument.		''value'' string as their second argument.
	<li>The Value property of an Element, Attribute, or Text node
			<li>The <var>Value</var> property of an Element, Attribute, or Text node
	may use the ''value'' string as the right		may use the ''value'' string as the right
	side of an assignment (subject to restrictions on null strings).		side of an assignment (subject to restrictions on null strings).
	</ul>		</ul>
	</ul>		</ul>
	===Request-Cancellation Errors===
			==Request-Cancellation Errors==
	<ul>		<ul>
	<li>IsValidString has no request cancellation errors.		<li><var>IsValidString</var> has no request cancellation errors.
	</ul>		</ul>

Dme: moved IsValidString (obsolete shared XmlDoc function) to IsValidString (XmlDoc function)

2012-07-23T21:01:04Z

moved IsValidString (obsolete shared XmlDoc function) to IsValidString (XmlDoc function)

← Older revision	Revision as of 21:01, 23 July 2012
(No difference)

JALWiccan: 1 revision

2012-06-19T20:49:50Z

1 revision

← Older revision	Revision as of 20:49, 19 June 2012
(No difference)

Dme at 20:49, 19 June 2012

2012-06-19T20:49:48Z

Dme at 19:44, 31 December 2010

2010-12-31T19:44:52Z

New page

Valid XML Element/Attribute value?
[[Category:XmlDoc methods|IsValidString obsolete shared function]]
[[Category:XmlDoc API methods]]




IsValidString is a member of the [[XmlDoc class]].


This shared function determines whether a string value
is a valid XML Element or Attribute value.
Designed to be used prior to updating an XmlDoc, this function was new
as of version 6.8 of ''Sirius Mods'' and deprecated in favor of [[InvalidCharacterPosition (XmlDoc function)|InvalidCharacterPosition]] in version 7.0.
===Syntax===
%bool = %(XmlDoc):IsValidString(value)
====Syntax Terms====
<dl>
<dt>%bool
<dd>A declared enumeration object of type Boolean to contain the returned value
(<tt>True</tt> or <tt>False</tt>) of IsValidString.
For more information about enumerations, see [[Enumerations]].
<dt>%(XmlDoc)
<dd>The class name in parentheses denotes a shared method;
you may instead provide an XmlDoc object expression (for example, a %variable).
For more information about shared methods, see [[??]] refid=shared..
<dt>value
<dd>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.

</dl>
===Usage Notes===
<ul>
<li>IsValidString returns <tt>True</tt> if its argument string is:
<ul>
<li>Unicode, and all characters are legal in an Element or Attribute value
(that is, it does not contain any null characters).
<li>EBCDIC, and all characters are translatable to Unicode characters
other than the null character.
</ul>

Otherwise, it returns <tt>False</tt>.

Prior to ''Sirius Mods'' 7.6, the invalid characters of an Element or Attribute
node were the EBCDIC “control characters.”
<li>If the result of the IsValidString call is <tt>True</tt>:
<ul>
<li>The AddAttribute, AddElement, AddText, InsertTextBefore,
and InsertElementBefore functions may use the
''value'' string as their second argument.
<li>The Value property of an Element, Attribute, or Text node
may use the ''value'' string as the right
side of an assignment (subject to restrictions on null strings).
</ul>
</ul>
===Request-Cancellation Errors===
<ul>
<li>IsValidString has no request cancellation errors.
</ul>

Admin: 1 revision

2010-12-07T00:33:14Z

1 revision

← Older revision	Revision as of 00:33, 7 December 2010
(No difference)

198.242.244.47: Created page with "Valid XML Element/Attribute value? IsValidString obsolete shared function [[Category:XmlDoc AP..."

2010-12-07T00:13:19Z

Created page with "Valid XML Element/Attribute value? IsValidString obsolete shared function [[Category:XmlDoc AP..."

New page

Valid XML Element/Attribute value?
[[Category:XmlDoc methods|IsValidString obsolete shared function]]
[[Category:XmlDoc API methods]]
[[Category:System methods]]




IsValidString is a member of the [[XmlDoc class]].


This shared function determines whether a string value
is a valid XML Element or Attribute value.
Designed to be used prior to updating an XmlDoc, this function was new
as of version 6.8 of ''Sirius Mods'' and deprecated in favor of InvalidCharacterPosition
(??[[InvalidCharacterPosition (XmlDoc function)|InvalidCharacterPosition]]) in version 7.0.
===Syntax===
%bool = %(XmlDoc):IsValidString(value)
====Syntax Terms====
<dl>
<dt>%bool
<dd>A declared enumeration object of type Boolean to contain the returned value
(<tt>True</tt> or <tt>False</tt>) of IsValidString.
For more information about enumerations, see [[Enumerations]].
<dt>%(XmlDoc)
<dd>The class name in parentheses denotes a shared method;
you may instead provide an XmlDoc object expression (for example, a %variable).
For more information about shared methods, see [[??]] refid=shared..
<dt>value
<dd>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.

</dl>
===Usage Notes===
<ul>
<li>IsValidString returns <tt>True</tt> if its argument string is:
<ul>
<li>Unicode, and all characters are legal in an Element or Attribute value
(that is, it does not contain any null characters).
<li>EBCDIC, and all characters are translatable to Unicode characters
other than the null character.
</ul>

Otherwise, it returns <tt>False</tt>.

Prior to ''Sirius Mods'' 7.6, the invalid characters of an Element or Attribute
node were the EBCDIC “control characters.”
<li>If the result of the IsValidString call is <tt>True</tt>:
<ul>
<li>The AddAttribute, AddElement, AddText, InsertTextBefore,
and InsertElementBefore functions may use the
''value'' string as their second argument.
<li>The Value property of an Element, Attribute, or Text node
may use the ''value'' string as the right
side of an assignment (subject to restrictions on null strings).
</ul>
</ul>
===Request-Cancellation Errors===
<ul>
<li>IsValidString has no request cancellation errors.
</ul>

← Older revision		Revision as of 20:49, 19 June 2012
Line 12:		Line 12:
	is a valid XML Element or Attribute value.		is a valid XML Element or Attribute value.
	Designed to be used prior to updating an XmlDoc, this function was new		Designed to be used prior to updating an XmlDoc, this function was new
	as of version 6.8 of ''Sirius Mods'' and deprecated in favor of [[InvalidCharacterPosition (XmlDoc function)\|InvalidCharacterPosition]] in version 7.0.		as of version 6.8 of <var class="product">Sirius Mods</var> and deprecated in favor of [[InvalidCharacterPosition (XmlDoc function)\|InvalidCharacterPosition]] in version 7.0.
	===Syntax===		===Syntax===
	%bool = %(XmlDoc):IsValidString(value)		%bool = %(XmlDoc):IsValidString(value)
Line 27:		Line 27:
	<dt><i><b>value</b></i>		<dt><i><b>value</b></i>
	<dd>The input string whose characters are to be validated.		<dd>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.		As of <var class="product">Sirius Mods</var> version 7.6, this may be a Unicode string or an EBCDIC string.
	Formerly, only EBCDIC was allowed.		Formerly, only EBCDIC was allowed.

Line 43:		Line 43:
	Otherwise, it returns <tt>False</tt>.		Otherwise, it returns <tt>False</tt>.

	Prior to ''Sirius Mods'' 7.6, the invalid characters of an Element or Attribute		Prior to <var class="product">Sirius Mods</var> 7.6, the invalid characters of an Element or Attribute
	node were the EBCDIC “control characters.”		node were the EBCDIC “control characters.”
	<li>If the result of the IsValidString call is <tt>True</tt>:		<li>If the result of the IsValidString call is <tt>True</tt>: